- 2.48.0 (latest)
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.7
- 2.2.1
- 2.1.12
public static final class Gateway.Builder extends 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Gateway.BuilderImplements
GatewayOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Gateway.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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 |
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 API Gateway host name of the form
{gateway_id}-{hash}.{region_code}.gateway.dev
.
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. |
clearField(Descriptors.FieldDescriptor field)
public Gateway.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Gateway.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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. |
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 |
clone()
public Gateway.Builder clone()
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 API Gateway host name of the form
{gateway_id}-{hash}.{region_code}.gateway.dev
.
string default_hostname = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The defaultHostname. |
getDefaultHostnameBytes()
public 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];
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 |
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. |
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. |
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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Gateway.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Gateway.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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 API Gateway host name of the form
{gateway_id}-{hash}.{region_code}.gateway.dev
.
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 API Gateway host name of the form
{gateway_id}-{hash}.{region_code}.gateway.dev
.
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. |
setField(Descriptors.FieldDescriptor field, Object value)
public Gateway.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Gateway.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Gateway.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Gateway.Builder |
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 |