publicfinalclass ApiVersionextendsGeneratedMessageV3implementsApiVersionOrBuilder
Describes a particular version of an API.
ApiVersions are what consumers actually use.
Protobuf type google.cloud.apigeeregistry.v1.ApiVersion
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
ANNOTATIONS_FIELD_NUMBER
publicstaticfinalintANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
CREATE_TIME_FIELD_NUMBER
publicstaticfinalintCREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
DESCRIPTION_FIELD_NUMBER
publicstaticfinalintDESCRIPTION_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 |
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()
publicstaticApiVersiongetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticApiVersion.BuildernewBuilder()
newBuilder(ApiVersion prototype)
publicstaticApiVersion.BuildernewBuilder(ApiVersionprototype)
publicstaticApiVersionparseDelimitedFrom(InputStreaminput)
publicstaticApiVersionparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticApiVersionparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticApiVersionparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticApiVersionparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticApiVersionparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticApiVersionparseFrom(CodedInputStreaminput)
publicstaticApiVersionparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticApiVersionparseFrom(InputStreaminput)
publicstaticApiVersionparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticApiVersionparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticApiVersionparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<ApiVersion>parser()
Methods
containsAnnotations(String key)
publicbooleancontainsAnnotations(Stringkey)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 8;
| Parameter |
| Name |
Description |
key |
String
|
containsLabels(String key)
publicbooleancontainsLabels(Stringkey)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 7;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations() (deprecated)
publicMap<String,String>getAnnotations()
getAnnotationsCount()
publicintgetAnnotationsCount()
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 8;
| Returns |
| Type |
Description |
int |
getAnnotationsMap()
publicMap<String,String>getAnnotationsMap()
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 8;
getAnnotationsOrDefault(String key, String defaultValue)
publicStringgetAnnotationsOrDefault(Stringkey,StringdefaultValue)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 8;
| Returns |
| Type |
Description |
String |
getAnnotationsOrThrow(String key)
publicStringgetAnnotationsOrThrow(Stringkey)
Annotations attach non-identifying metadata to resources.
Annotation keys and values are less restricted than those of labels, but
should be generally used for small values of broad interest. Larger, topic-
specific metadata should be stored in Artifacts.
map<string, string> annotations = 8;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
getCreateTime()
publicTimestampgetCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
publicTimestampOrBuildergetCreateTimeOrBuilder()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
publicApiVersiongetDefaultInstanceForType()
getDescription()
publicStringgetDescription()
A detailed description.
string description = 3;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
publicByteStringgetDescriptionBytes()
A detailed description.
string description = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getDisplayName()
publicStringgetDisplayName()
Human-meaningful name.
string display_name = 2;
| Returns |
| Type |
Description |
String |
The displayName.
|
getDisplayNameBytes()
publicByteStringgetDisplayNameBytes()
Human-meaningful name.
string display_name = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for displayName.
|
getLabels() (deprecated)
publicMap<String,String>getLabels()
getLabelsCount()
publicintgetLabelsCount()
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 7;
| Returns |
| Type |
Description |
int |
getLabelsMap()
publicMap<String,String>getLabelsMap()
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 7;
getLabelsOrDefault(String key, String defaultValue)
publicStringgetLabelsOrDefault(Stringkey,StringdefaultValue)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 7;
| Returns |
| Type |
Description |
String |
getLabelsOrThrow(String key)
publicStringgetLabelsOrThrow(Stringkey)
Labels attach identifying metadata to resources. Identifying metadata can
be used to filter list operations.
Label keys and values can be no longer than 64 characters
(Unicode codepoints), can only contain lowercase letters, numeric
characters, underscores and dashes. International characters are allowed.
No more than 64 user labels can be associated with one resource (System
labels are excluded).
See https://goo.gl/xmQnxf for more information and examples of labels.
System reserved label keys are prefixed with
apigeeregistry.googleapis.com/ and cannot be changed.
map<string, string> labels = 7;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
getName()
Resource name.
string name = 1;
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
publicByteStringgetNameBytes()
Resource name.
string name = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
publicParser<ApiVersion>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getState()
A user-definable description of the lifecycle phase of this API version.
Format: free-form, but we expect single words that describe API maturity,
e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION",
"DEPRECATED", "RETIRED".
string state = 6;
| Returns |
| Type |
Description |
String |
The state.
|
getStateBytes()
publicByteStringgetStateBytes()
A user-definable description of the lifecycle phase of this API version.
Format: free-form, but we expect single words that describe API maturity,
e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION",
"DEPRECATED", "RETIRED".
string state = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for state.
|
getUpdateTime()
publicTimestampgetUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
publicTimestampOrBuildergetUpdateTimeOrBuilder()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
publicbooleanhasCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasUpdateTime()
publicbooleanhasUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.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()
publicApiVersion.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedApiVersion.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicApiVersion.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides