Class Gateway (0.14.1) 

public final class Gateway extends GeneratedMessageV3 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.events.cloud.apigateway.v1.Gateway

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Gateway

Implements

GatewayOrBuilder

Static Fields

API_CONFIG_FIELD_NUMBER

public static final int API_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_HOSTNAME_FIELD_NUMBER

public static final int DEFAULT_HOSTNAME_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Gateway getDefaultInstance()
Returns
TypeDescription
Gateway

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Gateway.Builder newBuilder()
Returns
TypeDescription
Gateway.Builder

newBuilder(Gateway prototype)

public static Gateway.Builder newBuilder(Gateway prototype)
Parameter
NameDescription
prototypeGateway
Returns
TypeDescription
Gateway.Builder

parseDelimitedFrom(InputStream input)

public static Gateway parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Gateway parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Gateway parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Gateway parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Gateway parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Gateway parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Gateway
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Gateway> parser()
Returns
TypeDescription
Parser<Gateway>

Methods

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for apiConfig.

getCreateTime()

public Timestamp getCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for defaultHostname.

getDefaultInstanceForType()

public Gateway getDefaultInstanceForType()
Returns
TypeDescription
Gateway

getDisplayName()

public String getDisplayName()

Optional. Display name.

string display_name = 5;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name.

string display_name = 5;

Returns
TypeDescription
ByteString

The bytes for displayName.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Gateway> getParserForType()
Returns
TypeDescription
Parser<Gateway>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getState()

public Gateway.State getState()

Output only. The current state of the Gateway.

.google.events.cloud.apigateway.v1.Gateway.State state = 7;

Returns
TypeDescription
Gateway.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the Gateway.

.google.events.cloud.apigateway.v1.Gateway.State state = 7;

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Created time.

.google.protobuf.Timestamp create_time = 2;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Updated time.

.google.protobuf.Timestamp update_time = 3;

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Gateway.Builder newBuilderForType()
Returns
TypeDescription
Gateway.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Gateway.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Gateway.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Gateway.Builder toBuilder()
Returns
TypeDescription
Gateway.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException