public final class ApiDeployment extends GeneratedMessageV3 implements ApiDeploymentOrBuilder
Describes a service running at particular address that
provides a particular version of an API. ApiDeployments have revisions which
correspond to different configurations of a single deployment in time.
Revision identifiers should be updated whenever the served API spec or
endpoint address changes.
Protobuf type google.cloud.apigeeregistry.v1.ApiDeployment
Static Fields
ACCESS_GUIDANCE_FIELD_NUMBER
public static final int ACCESS_GUIDANCE_FIELD_NUMBER
Field Value
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
API_SPEC_REVISION_FIELD_NUMBER
public static final int API_SPEC_REVISION_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
ENDPOINT_URI_FIELD_NUMBER
public static final int ENDPOINT_URI_FIELD_NUMBER
Field Value
EXTERNAL_CHANNEL_URI_FIELD_NUMBER
public static final int EXTERNAL_CHANNEL_URI_FIELD_NUMBER
Field Value
INTENDED_AUDIENCE_FIELD_NUMBER
public static final int INTENDED_AUDIENCE_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
REVISION_CREATE_TIME_FIELD_NUMBER
public static final int REVISION_CREATE_TIME_FIELD_NUMBER
Field Value
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
Field Value
REVISION_UPDATE_TIME_FIELD_NUMBER
public static final int REVISION_UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ApiDeployment getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ApiDeployment.Builder newBuilder()
Returns
newBuilder(ApiDeployment prototype)
public static ApiDeployment.Builder newBuilder(ApiDeployment prototype)
Parameter
Returns
public static ApiDeployment parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ApiDeployment parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ApiDeployment parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ApiDeployment parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ApiDeployment parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ApiDeployment parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ApiDeployment parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ApiDeployment parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ApiDeployment parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ApiDeployment parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ApiDeployment parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ApiDeployment parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ApiDeployment> 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 = 15;
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 = 14;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAccessGuidance()
public String getAccessGuidance()
Text briefly describing how to access the endpoint. Changes to this value
will not affect the revision.
string access_guidance = 12;
| Type | Description |
| String | The accessGuidance.
|
getAccessGuidanceBytes()
public ByteString getAccessGuidanceBytes()
Text briefly describing how to access the endpoint. Changes to this value
will not affect the revision.
string access_guidance = 12;
| Type | Description |
| ByteString | The bytes for accessGuidance.
|
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 = 15;
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 = 15;
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 = 15;
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 = 15;
getApiSpecRevision()
public String getApiSpecRevision()
The full resource name (including revision ID) of the spec of the API being
served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }
| Type | Description |
| String | The apiSpecRevision.
|
getApiSpecRevisionBytes()
public ByteString getApiSpecRevisionBytes()
The full resource name (including revision ID) of the spec of the API being
served by the deployment. Changes to this value will update the revision.
Format: apis/{api}/deployments/{deployment}
string api_spec_revision = 8 [(.google.api.resource_reference) = { ... }
| Type | Description |
| ByteString | The bytes for apiSpecRevision.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public ApiDeployment 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.
|
getEndpointUri()
public String getEndpointUri()
The address where the deployment is serving. Changes to this value will
update the revision.
string endpoint_uri = 9;
| Type | Description |
| String | The endpointUri.
|
getEndpointUriBytes()
public ByteString getEndpointUriBytes()
The address where the deployment is serving. Changes to this value will
update the revision.
string endpoint_uri = 9;
| Type | Description |
| ByteString | The bytes for endpointUri.
|
getExternalChannelUri()
public String getExternalChannelUri()
The address of the external channel of the API (e.g., the Developer
Portal). Changes to this value will not affect the revision.
string external_channel_uri = 10;
| Type | Description |
| String | The externalChannelUri.
|
getExternalChannelUriBytes()
public ByteString getExternalChannelUriBytes()
The address of the external channel of the API (e.g., the Developer
Portal). Changes to this value will not affect the revision.
string external_channel_uri = 10;
| Type | Description |
| ByteString | The bytes for externalChannelUri.
|
getIntendedAudience()
public String getIntendedAudience()
Text briefly identifying the intended audience of the API. Changes to this
value will not affect the revision.
string intended_audience = 11;
| Type | Description |
| String | The intendedAudience.
|
getIntendedAudienceBytes()
public ByteString getIntendedAudienceBytes()
Text briefly identifying the intended audience of the API. Changes to this
value will not affect the revision.
string intended_audience = 11;
| Type | Description |
| ByteString | The bytes for intendedAudience.
|
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 = 14;
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 = 14;
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 = 14;
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 = 14;
getName()
Resource name.
string name = 1;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Resource name.
string name = 1;
getParserForType()
public Parser<ApiDeployment> getParserForType()
Returns
Overrides
getRevisionCreateTime()
public Timestamp getRevisionCreateTime()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The revisionCreateTime.
|
getRevisionCreateTimeOrBuilder()
public TimestampOrBuilder getRevisionCreateTimeOrBuilder()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getRevisionId()
public String getRevisionId()
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever the deployment contents are changed.
The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The revisionId.
|
getRevisionIdBytes()
public ByteString getRevisionIdBytes()
Output only. Immutable. The revision ID of the deployment.
A new revision is committed whenever the deployment contents are changed.
The format is an 8-character hexadecimal string.
string revision_id = 4 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| ByteString | The bytes for revisionId.
|
getRevisionUpdateTime()
public Timestamp getRevisionUpdateTime()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| Timestamp | The revisionUpdateTime.
|
getRevisionUpdateTimeOrBuilder()
public TimestampOrBuilder getRevisionUpdateTimeOrBuilder()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasCreateTime()
public boolean hasCreateTime()
Output only. Creation timestamp; when the deployment resource was created.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
hasRevisionCreateTime()
public boolean hasRevisionCreateTime()
Output only. Revision creation timestamp; when the represented revision was created.
.google.protobuf.Timestamp revision_create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the revisionCreateTime field is set.
|
hasRevisionUpdateTime()
public boolean hasRevisionUpdateTime()
Output only. Last update timestamp: when the represented revision was last modified.
.google.protobuf.Timestamp revision_update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the revisionUpdateTime 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 ApiDeployment.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ApiDeployment.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ApiDeployment.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
