public final class Api extends GeneratedMessageV3 implements ApiOrBuilder
An Api is a top-level description of an API.
Apis are produced by producers and are commitments to provide services.
Protobuf type google.cloud.apigeeregistry.v1.Api
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
AVAILABILITY_FIELD_NUMBER
public static final int AVAILABILITY_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RECOMMENDED_DEPLOYMENT_FIELD_NUMBER
public static final int RECOMMENDED_DEPLOYMENT_FIELD_NUMBER
Field Value
RECOMMENDED_VERSION_FIELD_NUMBER
public static final int RECOMMENDED_VERSION_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Api getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Api.Builder newBuilder()
Returns
newBuilder(Api prototype)
public static Api.Builder newBuilder(Api prototype)
Parameter
| Name | Description |
| prototype | Api
|
Returns
public static Api parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Api parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Api parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Api parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Api parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Api parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Api parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Api parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Api parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Api parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Api> parser()
Returns
Methods
containsAnnotations(String key)
public boolean containsAnnotations(String key)
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 = 10;
containsLabels(String key)
public boolean containsLabels(String key)
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 = 9;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public int getAnnotationsCount()
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 = 10;
getAnnotationsMap()
public Map<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 = 10;
getAnnotationsOrDefault(String key, String defaultValue)
public String getAnnotationsOrDefault(String key, String defaultValue)
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 = 10;
getAnnotationsOrThrow(String key)
public String getAnnotationsOrThrow(String key)
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 = 10;
getAvailability()
public String getAvailability()
A user-definable description of the availability of this service.
Format: free-form, but we expect single words that describe availability,
e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
string availability = 6;
| Type | Description |
| String | The availability.
|
getAvailabilityBytes()
public ByteString getAvailabilityBytes()
A user-definable description of the availability of this service.
Format: free-form, but we expect single words that describe availability,
e.g. "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
string availability = 6;
| Type | Description |
| ByteString | The bytes for availability.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Api getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
A detailed description.
string description = 3;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A detailed description.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Human-meaningful name.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Human-meaningful name.
string display_name = 2;
| Type | Description |
| ByteString | The bytes for displayName.
|
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
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 = 9;
getLabelsMap()
public Map<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 = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
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 = 9;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
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 = 9;
getName()
Resource name.
string name = 1;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Resource name.
string name = 1;
getParserForType()
public Parser<Api> getParserForType()
Returns
Overrides
getRecommendedDeployment()
public String getRecommendedDeployment()
The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The recommendedDeployment.
|
getRecommendedDeploymentBytes()
public ByteString getRecommendedDeploymentBytes()
The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for recommendedDeployment.
|
getRecommendedVersion()
public String getRecommendedVersion()
The recommended version of the API.
Format: apis/{api}/versions/{version}
string recommended_version = 7 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The recommendedVersion.
|
getRecommendedVersionBytes()
public ByteString getRecommendedVersionBytes()
The recommended version of the API.
Format: apis/{api}/versions/{version}
string recommended_version = 7 [(.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for recommendedVersion.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation timestamp.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Api.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Api.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Api.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
