Class Gateway.Builder (2.99.0) 

public static final class Gateway.Builder extends GeneratedMessage.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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Gateway.Builder

Implements

GatewayOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public Gateway build()
Returns
Type Description
Gateway

buildPartial()

public Gateway buildPartial()
Returns
Type Description
Gateway

clear()

public Gateway.Builder clear()
Returns
Type Description
Gateway.Builder
Overrides

clearApiConfig()

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) = { ... }

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearCreateTime()

public Gateway.Builder clearCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Gateway.Builder

clearDefaultHostname()

public Gateway.Builder clearDefaultHostname()

Output only. The default hostname that serves traffic for this Gateway.

string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearDisplayName()

public Gateway.Builder clearDisplayName()

Optional. Display name.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearEffectiveStreamingMode()

public Gateway.Builder clearEffectiveStreamingMode()

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the platform default at the time. Read this rather than streaming_mode to determine whether a gateway supports streaming.

.google.cloud.apigateway.v1.Gateway.EffectiveStreamingMode effective_streaming_mode = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearLabels()

public Gateway.Builder clearLabels()
Returns
Type Description
Gateway.Builder

clearName()

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];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearState()

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];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearStreamingMode()

public Gateway.Builder clearStreamingMode()

Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

.google.cloud.apigateway.v1.Gateway.StreamingMode streaming_mode = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Gateway.Builder

This builder for chaining.

clearUpdateTime()

public Gateway.Builder clearUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Gateway.Builder

containsLabels(String key)

public 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];

Parameter
Name Description
key String
Returns
Type Description
boolean

getApiConfig()

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) = { ... }

Returns
Type Description
String

The apiConfig.

getApiConfigBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for apiConfig.

getCreateTime()

public Timestamp getCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultHostname()

public String getDefaultHostname()

Output only. The default hostname that serves traffic for this Gateway.

string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The defaultHostname.

getDefaultHostnameBytes()

public ByteString getDefaultHostnameBytes()

Output only. The default hostname that serves traffic for this Gateway.

string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for defaultHostname.

getDefaultInstanceForType()

public Gateway getDefaultInstanceForType()
Returns
Type Description
Gateway

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. Display name.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEffectiveStreamingMode()

public Gateway.EffectiveStreamingMode getEffectiveStreamingMode()

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the platform default at the time. Read this rather than streaming_mode to determine whether a gateway supports streaming.

.google.cloud.apigateway.v1.Gateway.EffectiveStreamingMode effective_streaming_mode = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Gateway.EffectiveStreamingMode

The effectiveStreamingMode.

getEffectiveStreamingModeValue()

public int getEffectiveStreamingModeValue()

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the platform default at the time. Read this rather than streaming_mode to determine whether a gateway supports streaming.

.google.cloud.apigateway.v1.Gateway.EffectiveStreamingMode effective_streaming_mode = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for effectiveStreamingMode.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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];

Returns
Type Description
int

getLabelsMap()

public 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];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public 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];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public 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];

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public 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];

Returns
Type Description
String

The name.

getNameBytes()

public 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];

Returns
Type Description
ByteString

The bytes for name.

getState()

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];

Returns
Type Description
Gateway.State

The state.

getStateValue()

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];

Returns
Type Description
int

The enum numeric value on the wire for state.

getStreamingMode()

public Gateway.StreamingMode getStreamingMode()

Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

.google.cloud.apigateway.v1.Gateway.StreamingMode streaming_mode = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Gateway.StreamingMode

The streamingMode.

getStreamingModeValue()

public int getStreamingModeValue()

Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

.google.cloud.apigateway.v1.Gateway.StreamingMode streaming_mode = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for streamingMode.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Gateway.Builder mergeCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Gateway.Builder

mergeFrom(Gateway other)

public Gateway.Builder mergeFrom(Gateway other)
Parameter
Name Description
other Gateway
Returns
Type Description
Gateway.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Gateway.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Gateway.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Gateway.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Gateway.Builder mergeUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Gateway.Builder

putAllLabels(Map<String,String> values)

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];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Gateway.Builder

putLabels(String key, String value)

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];

Parameters
Name Description
key String
value String
Returns
Type Description
Gateway.Builder

removeLabels(String key)

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];

Parameter
Name Description
key String
Returns
Type Description
Gateway.Builder

setApiConfig(String value)

public 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) = { ... }

Parameter
Name Description
value String

The apiConfig to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setApiConfigBytes(ByteString value)

public Gateway.Builder setApiConfigBytes(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) = { ... }

Parameter
Name Description
value ByteString

The bytes for apiConfig to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Gateway.Builder setCreateTime(Timestamp value)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Gateway.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Gateway.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Created time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Gateway.Builder

setDefaultHostname(String value)

public Gateway.Builder setDefaultHostname(String value)

Output only. The default hostname that serves traffic for this Gateway.

string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The defaultHostname to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setDefaultHostnameBytes(ByteString value)

public Gateway.Builder setDefaultHostnameBytes(ByteString value)

Output only. The default hostname that serves traffic for this Gateway.

string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for defaultHostname to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setDisplayName(String value)

public Gateway.Builder setDisplayName(String value)

Optional. Display name.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Gateway.Builder setDisplayNameBytes(ByteString value)

Optional. Display name.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setEffectiveStreamingMode(Gateway.EffectiveStreamingMode value)

public Gateway.Builder setEffectiveStreamingMode(Gateway.EffectiveStreamingMode value)

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the platform default at the time. Read this rather than streaming_mode to determine whether a gateway supports streaming.

.google.cloud.apigateway.v1.Gateway.EffectiveStreamingMode effective_streaming_mode = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Gateway.EffectiveStreamingMode

The effectiveStreamingMode to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setEffectiveStreamingModeValue(int value)

public Gateway.Builder setEffectiveStreamingModeValue(int value)

Output only. The streaming mode this gateway is actually served with, which the service resolves at creation from streaming_mode, the referenced API Config, and the platform default at the time. Read this rather than streaming_mode to determine whether a gateway supports streaming.

.google.cloud.apigateway.v1.Gateway.EffectiveStreamingMode effective_streaming_mode = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for effectiveStreamingMode to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setName(String value)

public 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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Gateway.Builder setNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setState(Gateway.State value)

public 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];

Parameter
Name Description
value Gateway.State

The state to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setStateValue(int value)

public 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];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setStreamingMode(Gateway.StreamingMode value)

public Gateway.Builder setStreamingMode(Gateway.StreamingMode value)

Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

.google.cloud.apigateway.v1.Gateway.StreamingMode streaming_mode = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Gateway.StreamingMode

The streamingMode to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setStreamingModeValue(int value)

public Gateway.Builder setStreamingModeValue(int value)

Optional. Immutable. Requests streaming for a new gateway. An attempt to change it on update is rejected. If unset, the service selects the mode. This field records only what was requested and is never modified by the service; read effective_streaming_mode for the mode the gateway is served with.

.google.cloud.apigateway.v1.Gateway.StreamingMode streaming_mode = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for streamingMode to set.
Returns
Type Description
Gateway.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public Gateway.Builder setUpdateTime(Timestamp value)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Gateway.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Gateway.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Gateway.Builder