publicfinalclass ApiextendsGeneratedMessageV3implementsApiOrBuilder
An API that can be served by one or more Gateways.
Protobuf type google.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
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
DISPLAY_NAME_FIELD_NUMBER
publicstaticfinalintDISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LABELS_FIELD_NUMBER
publicstaticfinalintLABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
MANAGED_SERVICE_FIELD_NUMBER
publicstaticfinalintMANAGED_SERVICE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
STATE_FIELD_NUMBER
publicstaticfinalintSTATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
UPDATE_TIME_FIELD_NUMBER
publicstaticfinalintUPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticApigetDefaultInstance()
| Returns |
| Type |
Description |
Api |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticApi.BuildernewBuilder()
newBuilder(Api prototype)
publicstaticApi.BuildernewBuilder(Apiprototype)
| Parameter |
| Name |
Description |
prototype |
Api
|
publicstaticApiparseDelimitedFrom(InputStreaminput)
| Returns |
| Type |
Description |
Api |
publicstaticApiparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
parseFrom(byte[] data)
publicstaticApiparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Api |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticApiparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
parseFrom(ByteString data)
publicstaticApiparseFrom(ByteStringdata)
| Returns |
| Type |
Description |
Api |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticApiparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
publicstaticApiparseFrom(CodedInputStreaminput)
| Returns |
| Type |
Description |
Api |
publicstaticApiparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
publicstaticApiparseFrom(InputStreaminput)
| Returns |
| Type |
Description |
Api |
publicstaticApiparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
parseFrom(ByteBuffer data)
publicstaticApiparseFrom(ByteBufferdata)
| Returns |
| Type |
Description |
Api |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticApiparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
| Returns |
| Type |
Description |
Api |
parser()
publicstaticParser<Api>parser()
Methods
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCreateTime()
publicTimestampgetCreateTime()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. Created time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicApigetDefaultInstanceForType()
| Returns |
| Type |
Description |
Api |
getDisplayName()
publicStringgetDisplayName()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
publicByteStringgetDisplayNameBytes()
Optional. Display name.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getLabels() (deprecated)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
| Returns |
| Type |
Description |
int |
getLabelsMap()
publicMap<String,String>getLabelsMap()
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)
| Returns |
| Type |
Description |
String |
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
getManagedService()
publicStringgetManagedService()
Optional. Immutable. The name of a Google Managed Service (
https://cloud.google.com/service-infrastructure/docs/glossary#managed). If
not specified, a new Service will automatically be created in the same
project as this API.
string managed_service = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The managedService.
|
getManagedServiceBytes()
publicByteStringgetManagedServiceBytes()
Optional. Immutable. The name of a Google Managed Service (
https://cloud.google.com/service-infrastructure/docs/glossary#managed). If
not specified, a new Service will automatically be created in the same
project as this API.
string managed_service = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
publicByteStringgetNameBytes()
Output only. Resource name of the API.
Format: projects/{project}/locations/global/apis/{api}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
publicParser<Api>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getState()
publicApi.StategetState()
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Api.State |
The state.
|
getStateValue()
Output only. State of the API.
.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUpdateTime()
publicTimestampgetUpdateTime()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. Updated time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
publicbooleanhasCreateTime()
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()
publicbooleanhasUpdateTime()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicApi.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedApi.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicApi.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides