Send feedback
Class Api (0.16.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public final class Api extends GeneratedMessageV3 implements ApiOrBuilder
An API that can be served by one or more Gateways.
Protobuf type google.events.cloud.apigateway.v1.Api
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
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_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
MANAGED_SERVICE_FIELD_NUMBER
public static final int MANAGED_SERVICE_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 Api getDefaultInstance ()
Returns
Type Description
Api
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Api . Builder newBuilder ()
newBuilder(Api prototype)
public static Api . Builder newBuilder ( Api prototype )
Parameter
Name Description
prototypeApi
public static Api parseDelimitedFrom ( InputStream input )
Returns
Type Description
Api
public static Api parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
parseFrom(byte[] data)
public static Api parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Api
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
parseFrom(ByteString data)
public static Api parseFrom ( ByteString data )
Returns
Type Description
Api
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
public static Api parseFrom ( CodedInputStream input )
Returns
Type Description
Api
public static Api parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
public static Api parseFrom ( InputStream input )
Returns
Type Description
Api
public static Api parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
parseFrom(ByteBuffer data)
public static Api parseFrom ( ByteBuffer data )
Returns
Type Description
Api
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Api
parser()
public static Parser<Api> 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
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;
getDefaultInstanceForType()
public Api getDefaultInstanceForType ()
Returns
Type Description
Api
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
getManagedService()
public String getManagedService ()
Returns
Type Description
String The managedService.
getManagedServiceBytes()
public ByteString getManagedServiceBytes ()
Returns
Type Description
ByteString The bytes for managedService.
getName()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1;
Returns
Type Description
String The name.
getNameBytes()
public ByteString getNameBytes ()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1;
Returns
Type Description
ByteString The bytes for name.
getParserForType()
public Parser<Api> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getState()
public Api . State getState ()
Output only. State of the API.
.google.events.cloud.apigateway.v1.Api.State state = 12;
Returns
Type Description
Api.State The state.
getStateValue()
public int getStateValue ()
Output only. State of the API.
.google.events.cloud.apigateway.v1.Api.State state = 12;
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 Api . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Api . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Api . 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-14 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-14 UTC."],[],[]]
