com.google.cloud.apigateway.v1

Class Api

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.apigateway.v1.Api

All Implemented Interfaces:

ApiOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Api
extends com.google.protobuf.GeneratedMessageV3
implements ApiOrBuilder

 An API that can be served by one or more Gateways.
 

Protobuf type google.cloud.apigateway.v1.Api

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Api.Builder An API that can be served by one or more Gateways.
static class	Api.State All the possible API states.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CREATE_TIME_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	MANAGED_SERVICE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	STATE_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
boolean	equals(Object obj)
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static Api	getDefaultInstance()
Api	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Optional.
com.google.protobuf.ByteString	getDisplayNameBytes() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getManagedService() Optional.
com.google.protobuf.ByteString	getManagedServiceBytes() Optional.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
com.google.protobuf.Parser<Api>	getParserForType()
int	getSerializedSize()
Api.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
int	hashCode()
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Api.Builder	newBuilder()
static Api.Builder	newBuilder(Api prototype)
Api.Builder	newBuilderForType()
protected Api.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Api	parseDelimitedFrom(InputStream input)
static Api	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api	parseFrom(byte[] data)
static Api	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api	parseFrom(ByteBuffer data)
static Api	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api	parseFrom(com.google.protobuf.ByteString data)
static Api	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api	parseFrom(com.google.protobuf.CodedInputStream input)
static Api	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api	parseFrom(InputStream input)
static Api	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Api>	parser()
Api.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

MANAGED_SERVICE_FIELD_NUMBER

public static final int MANAGED_SERVICE_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 Output only. Resource name of the API.
 Format: projects/{project}/locations/global/apis/{api}
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getName in interface ApiOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the API.
 Format: projects/{project}/locations/global/apis/{api}
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getNameBytes in interface ApiOrBuilder

Returns:

The bytes for name.

hasCreateTime

public boolean hasCreateTime()

 Output only. Created time.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasCreateTime in interface ApiOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public com.google.protobuf.Timestamp getCreateTime()

 Output only. Created time.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTime in interface ApiOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Created time.
 

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getCreateTimeOrBuilder in interface ApiOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Updated time.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasUpdateTime in interface ApiOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

public com.google.protobuf.Timestamp getUpdateTime()

 Output only. Updated time.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTime in interface ApiOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Updated time.
 

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getUpdateTimeOrBuilder in interface ApiOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: ApiOrBuilder

 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];

Specified by:

getLabelsCount in interface ApiOrBuilder

containsLabels

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];

Specified by:

containsLabels in interface ApiOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface ApiOrBuilder

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];

Specified by:

getLabelsMap in interface ApiOrBuilder

getLabelsOrDefault

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];

Specified by:

getLabelsOrDefault in interface ApiOrBuilder

getLabelsOrThrow

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];

Specified by:

getLabelsOrThrow in interface ApiOrBuilder

getDisplayName

public String getDisplayName()

 Optional. Display name.
 

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDisplayName in interface ApiOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Optional. Display name.
 

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDisplayNameBytes in interface ApiOrBuilder

Returns:

The bytes for displayName.

getManagedService

public String getManagedService()

 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) = { ... }

Specified by:

getManagedService in interface ApiOrBuilder

Returns:

The managedService.

getManagedServiceBytes

public com.google.protobuf.ByteString getManagedServiceBytes()

 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) = { ... }

Specified by:

getManagedServiceBytes in interface ApiOrBuilder

Returns:

The bytes for managedService.

getStateValue

public int getStateValue()

 Output only. State of the API.
 

.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStateValue in interface ApiOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public Api.State getState()

 Output only. State of the API.
 

.google.cloud.apigateway.v1.Api.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getState in interface ApiOrBuilder

Returns:

The state.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Api parseFrom(ByteBuffer data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(ByteBuffer data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(com.google.protobuf.ByteString data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(com.google.protobuf.ByteString data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(byte[] data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(byte[] data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api parseFrom(InputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Api parseFrom(InputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Api parseDelimitedFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Api parseDelimitedFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseFrom

public static Api parseFrom(com.google.protobuf.CodedInputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Api parseFrom(com.google.protobuf.CodedInputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

newBuilderForType

public Api.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Api.Builder newBuilder()

newBuilder

public static Api.Builder newBuilder(Api prototype)

toBuilder

public Api.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Api.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Api getDefaultInstance()

parser

public static com.google.protobuf.Parser<Api> parser()

getParserForType

public com.google.protobuf.Parser<Api> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Api getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder