public final class Api extends GeneratedMessageV3 implements ApiOrBuilder
A top-level description of an API.
Produced by producers and are commitments to provide services.
Protobuf type google.cloud.apigeeregistry.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
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
AVAILABILITY_FIELD_NUMBER
public static final int AVAILABILITY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_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 | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECOMMENDED_DEPLOYMENT_FIELD_NUMBER
public static final int RECOMMENDED_DEPLOYMENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECOMMENDED_VERSION_FIELD_NUMBER
public static final int RECOMMENDED_VERSION_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 |
prototype | Api
|
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 |
data | byte[]
|
| 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
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;
| Parameter |
|---|
| Name | Description |
key | String
|
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;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
key | String
|
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;
| Returns |
|---|
| 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;
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
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 |
|---|
| Type | Description |
Api | |
getDescription()
public String getDescription()
A detailed description.
string description = 3;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
A detailed description.
string description = 3;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getDisplayName()
public String getDisplayName()
Human-meaningful name.
string display_name = 2;
| Returns |
|---|
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Human-meaningful name.
string display_name = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
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;
| Returns |
|---|
| Type | Description |
int | |
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;
| Parameter |
|---|
| Name | Description |
key | String
|
getName()
Resource name.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Resource name.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Api> getParserForType()
Overrides
getRecommendedDeployment()
public String getRecommendedDeployment()
The recommended deployment of the API.
Format: apis/{api}/deployments/{deployment}
string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for recommendedVersion.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update timestamp.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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)
Overrides
toBuilder()
public Api.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
