Send feedback
Class Gateway (0.16.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
API_CONFIG_FIELD_NUMBER
public static final int API_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
DEFAULT_HOSTNAME_FIELD_NUMBER
public static final int DEFAULT_HOSTNAME_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Gateway getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Gateway . Builder newBuilder ()
newBuilder(Gateway prototype)
public static Gateway . Builder newBuilder ( Gateway prototype )
Parameter
Name Description
prototypeGateway
public static Gateway parseDelimitedFrom ( InputStream input )
public static Gateway parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Gateway parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Gateway parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Gateway parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Gateway parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Gateway parseFrom ( CodedInputStream input )
public static Gateway parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Gateway parseFrom ( InputStream input )
public static Gateway parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Gateway parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Gateway parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Gateway> parser ()
Methods
containsLabels(String key)
public boolean containsLabels ( String key )
Parameter
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
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;
Returns
Type Description
ByteString The bytes for apiConfig.
getCreateTime()
public Timestamp getCreateTime ()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2;
Returns
Type Description
Timestamp The createTime.
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder ()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2;
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
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;
Returns
Type Description
ByteString The bytes for defaultHostname.
getDefaultInstanceForType()
public Gateway getDefaultInstanceForType ()
getDisplayName()
public String getDisplayName ()
Optional. Display name.
string display_name = 5;
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Optional. Display name.
string display_name = 5;
Returns
Type Description
ByteString The bytes for displayName.
getLabels()
public Map<String , String > getLabels ()
getLabelsCount()
public int getLabelsCount ()
Returns
Type Description
int
getLabelsMap()
public Map<String , String > getLabelsMap ()
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault ( String key , String defaultValue )
Returns
Type Description
String
getLabelsOrThrow(String key)
public String getLabelsOrThrow ( String key )
Parameter
Name Description
keyString
Returns
Type Description
String
getName()
Output only. Resource name of the Gateway.
Format: projects/{project}/locations/{location}/gateways/{gateway}
string name = 1;
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;
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Gateway> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getState()
public Gateway . State getState ()
Output only. The current state of the Gateway.
.google.events.cloud.apigateway.v1.Gateway.State state = 7;
getStateValue()
public int getStateValue ()
Output only. The current state of the Gateway.
.google.events.cloud.apigateway.v1.Gateway.State state = 7;
Returns
Type Description
int The enum numeric value on the wire for state.
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Overrides
getUpdateTime()
public Timestamp getUpdateTime ()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3;
Returns
Type Description
Timestamp The updateTime.
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder ()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3;
hasCreateTime()
public boolean hasCreateTime ()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2;
Returns
Type Description
boolean Whether the createTime field is set.
hasUpdateTime()
public boolean hasUpdateTime ()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3;
Returns
Type Description
boolean Whether the updateTime field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
numberint
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Gateway . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Gateway . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Gateway . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-03 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-03 UTC."],[],[]]
