public static final class Gateway.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder> implements GatewayOrBuilder
A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.Protobuf type
google.cloud.apigateway.v1.Gateway| Modifier and Type | Method and Description |
|---|---|
Gateway.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Gateway |
build() |
Gateway |
buildPartial() |
Gateway.Builder |
clear() |
Gateway.Builder |
clearApiConfig()
Required.
|
Gateway.Builder |
clearCreateTime()
Output only.
|
Gateway.Builder |
clearDefaultHostname()
Output only.
|
Gateway.Builder |
clearDisplayName()
Optional.
|
Gateway.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Gateway.Builder |
clearLabels() |
Gateway.Builder |
clearName()
Output only.
|
Gateway.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Gateway.Builder |
clearState()
Output only.
|
Gateway.Builder |
clearUpdateTime()
Output only.
|
Gateway.Builder |
clone() |
boolean |
containsLabels(String key)
Optional.
|
String |
getApiConfig()
Required.
|
com.google.protobuf.ByteString |
getApiConfigBytes()
Required.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getCreateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
String |
getDefaultHostname()
Output only.
|
com.google.protobuf.ByteString |
getDefaultHostnameBytes()
Output only.
|
Gateway |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
Optional.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Optional.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
Optional.
|
Map<String,String> |
getLabelsMap()
Optional.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
Optional.
|
String |
getLabelsOrThrow(String key)
Optional.
|
Map<String,String> |
getMutableLabels()
Deprecated.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
Gateway.State |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.Timestamp.Builder |
getUpdateTimeBuilder()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Gateway.Builder |
mergeCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Gateway.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Gateway.Builder |
mergeFrom(Gateway other) |
Gateway.Builder |
mergeFrom(com.google.protobuf.Message other) |
Gateway.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Gateway.Builder |
mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
Gateway.Builder |
putAllLabels(Map<String,String> values)
Optional.
|
Gateway.Builder |
putLabels(String key,
String value)
Optional.
|
Gateway.Builder |
removeLabels(String key)
Optional.
|
Gateway.Builder |
setApiConfig(String value)
Required.
|
Gateway.Builder |
setApiConfigBytes(com.google.protobuf.ByteString value)
Required.
|
Gateway.Builder |
setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
Gateway.Builder |
setCreateTime(com.google.protobuf.Timestamp value)
Output only.
|
Gateway.Builder |
setDefaultHostname(String value)
Output only.
|
Gateway.Builder |
setDefaultHostnameBytes(com.google.protobuf.ByteString value)
Output only.
|
Gateway.Builder |
setDisplayName(String value)
Optional.
|
Gateway.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
Optional.
|
Gateway.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Gateway.Builder |
setName(String value)
Output only.
|
Gateway.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Output only.
|
Gateway.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Gateway.Builder |
setState(Gateway.State value)
Output only.
|
Gateway.Builder |
setStateValue(int value)
Output only.
|
Gateway.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Gateway.Builder |
setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only.
|
Gateway.Builder |
setUpdateTime(com.google.protobuf.Timestamp value)
Output only.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Gateway build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Gateway buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Gateway.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Gateway.Builder>public Gateway.Builder mergeFrom(Gateway other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public Gateway.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Gateway.Builder>IOExceptionpublic String getName()
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface GatewayOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface GatewayOrBuilderpublic Gateway.Builder setName(String value)
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The name to set.public Gateway.Builder clearName()
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];public Gateway.Builder setNameBytes(com.google.protobuf.ByteString value)
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for name to set.public boolean hasCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface GatewayOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface GatewayOrBuilderpublic Gateway.Builder setCreateTime(com.google.protobuf.Timestamp value)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder clearCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface GatewayOrBuilderpublic boolean hasUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface GatewayOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface GatewayOrBuilderpublic Gateway.Builder setUpdateTime(com.google.protobuf.Timestamp value)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Gateway.Builder clearUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface GatewayOrBuilderpublic int getLabelsCount()
GatewayOrBuilderOptional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];getLabelsCount in interface GatewayOrBuilderpublic boolean containsLabels(String key)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];containsLabels in interface GatewayOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface GatewayOrBuilderpublic Map<String,String> getLabelsMap()
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];getLabelsMap in interface GatewayOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrDefault in interface GatewayOrBuilderpublic String getLabelsOrThrow(String key)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];getLabelsOrThrow in interface GatewayOrBuilderpublic Gateway.Builder clearLabels()
public Gateway.Builder removeLabels(String key)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];@Deprecated public Map<String,String> getMutableLabels()
public Gateway.Builder putLabels(String key, String value)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];public Gateway.Builder putAllLabels(Map<String,String> values)
Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];public String getDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];getDisplayName in interface GatewayOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];getDisplayNameBytes in interface GatewayOrBuilderpublic Gateway.Builder setDisplayName(String value)
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];value - The displayName to set.public Gateway.Builder clearDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];public Gateway.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for displayName to set.public String getApiConfig()
Required. Resource name of the API Config for this Gateway.
Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
string api_config = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getApiConfig in interface GatewayOrBuilderpublic com.google.protobuf.ByteString getApiConfigBytes()
Required. Resource name of the API Config for this Gateway.
Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
string api_config = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getApiConfigBytes in interface GatewayOrBuilderpublic Gateway.Builder setApiConfig(String value)
Required. Resource name of the API Config for this Gateway.
Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
string api_config = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The apiConfig to set.public Gateway.Builder clearApiConfig()
Required. Resource name of the API Config for this Gateway.
Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
string api_config = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public Gateway.Builder setApiConfigBytes(com.google.protobuf.ByteString value)
Required. Resource name of the API Config for this Gateway.
Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
string api_config = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
value - The bytes for apiConfig to set.public int getStateValue()
Output only. The current state of the Gateway.
.google.cloud.apigateway.v1.Gateway.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface GatewayOrBuilderpublic Gateway.Builder setStateValue(int value)
Output only. The current state of the Gateway.
.google.cloud.apigateway.v1.Gateway.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for state to set.public Gateway.State getState()
Output only. The current state of the Gateway.
.google.cloud.apigateway.v1.Gateway.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface GatewayOrBuilderpublic Gateway.Builder setState(Gateway.State value)
Output only. The current state of the Gateway.
.google.cloud.apigateway.v1.Gateway.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The state to set.public Gateway.Builder clearState()
Output only. The current state of the Gateway.
.google.cloud.apigateway.v1.Gateway.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public String getDefaultHostname()
Output only. The default API Gateway host name of the form
`{gateway_id}-{hash}.{region_code}.gateway.dev`.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];getDefaultHostname in interface GatewayOrBuilderpublic com.google.protobuf.ByteString getDefaultHostnameBytes()
Output only. The default API Gateway host name of the form
`{gateway_id}-{hash}.{region_code}.gateway.dev`.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];getDefaultHostnameBytes in interface GatewayOrBuilderpublic Gateway.Builder setDefaultHostname(String value)
Output only. The default API Gateway host name of the form
`{gateway_id}-{hash}.{region_code}.gateway.dev`.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The defaultHostname to set.public Gateway.Builder clearDefaultHostname()
Output only. The default API Gateway host name of the form
`{gateway_id}-{hash}.{region_code}.gateway.dev`.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];public Gateway.Builder setDefaultHostnameBytes(com.google.protobuf.ByteString value)
Output only. The default API Gateway host name of the form
`{gateway_id}-{hash}.{region_code}.gateway.dev`.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for defaultHostname to set.public final Gateway.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>public final Gateway.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Gateway.Builder>Copyright © 2022 Google LLC. All rights reserved.