Package com.google.cloud.apigeeregistry.v1

Class ApiDeployment

  • All Implemented Interfaces:
    ApiDeploymentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ApiDeployment
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Field Detail

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REVISION_ID_FIELD_NUMBER

        public static final int REVISION_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REVISION_CREATE_TIME_FIELD_NUMBER

        public static final int REVISION_CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REVISION_UPDATE_TIME_FIELD_NUMBER

        public static final int REVISION_UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • API_SPEC_REVISION_FIELD_NUMBER

        public static final int API_SPEC_REVISION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENDPOINT_URI_FIELD_NUMBER

        public static final int ENDPOINT_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXTERNAL_CHANNEL_URI_FIELD_NUMBER

        public static final int EXTERNAL_CHANNEL_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INTENDED_AUDIENCE_FIELD_NUMBER

        public static final int INTENDED_AUDIENCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACCESS_GUIDANCE_FIELD_NUMBER

        public static final int ACCESS_GUIDANCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANNOTATIONS_FIELD_NUMBER

        public static final int ANNOTATIONS_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

      • 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

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Resource name.
        string name = 1;
        Specified by:
        getNameBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for name.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         Human-meaningful name.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for displayName.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         A detailed description.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for description.

      • 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];
        Specified by:
        getRevisionId in interface ApiDeploymentOrBuilder
        Returns:
        The revisionId.

      • getRevisionIdBytes

        public com.google.protobuf.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];
        Specified by:
        getRevisionIdBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for revisionId.

      • 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];
        Specified by:
        hasCreateTime in interface ApiDeploymentOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Creation timestamp; when the deployment resource was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ApiDeploymentOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Creation timestamp; when the deployment resource was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ApiDeploymentOrBuilder

      • 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];
        Specified by:
        hasRevisionCreateTime in interface ApiDeploymentOrBuilder
        Returns:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        public com.google.protobuf.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];
        Specified by:
        getRevisionCreateTime in interface ApiDeploymentOrBuilder
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getRevisionCreateTimeOrBuilder in interface ApiDeploymentOrBuilder

      • 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];
        Specified by:
        hasRevisionUpdateTime in interface ApiDeploymentOrBuilder
        Returns:
        Whether the revisionUpdateTime field is set.

      • getRevisionUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getRevisionUpdateTime in interface ApiDeploymentOrBuilder
        Returns:
        The revisionUpdateTime.

      • getRevisionUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getRevisionUpdateTimeOrBuilder in interface ApiDeploymentOrBuilder

      • 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) = { ... }
        Specified by:
        getApiSpecRevision in interface ApiDeploymentOrBuilder
        Returns:
        The apiSpecRevision.

      • getApiSpecRevisionBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getApiSpecRevisionBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for apiSpecRevision.

      • getEndpointUri

        public String getEndpointUri()
         The address where the deployment is serving. Changes to this value will
 update the revision.
        string endpoint_uri = 9;
        Specified by:
        getEndpointUri in interface ApiDeploymentOrBuilder
        Returns:
        The endpointUri.

      • getEndpointUriBytes

        public com.google.protobuf.ByteString getEndpointUriBytes()
         The address where the deployment is serving. Changes to this value will
 update the revision.
        string endpoint_uri = 9;
        Specified by:
        getEndpointUriBytes in interface ApiDeploymentOrBuilder
        Returns:
        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;
        Specified by:
        getExternalChannelUri in interface ApiDeploymentOrBuilder
        Returns:
        The externalChannelUri.

      • getExternalChannelUriBytes

        public com.google.protobuf.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;
        Specified by:
        getExternalChannelUriBytes in interface ApiDeploymentOrBuilder
        Returns:
        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;
        Specified by:
        getIntendedAudience in interface ApiDeploymentOrBuilder
        Returns:
        The intendedAudience.

      • getIntendedAudienceBytes

        public com.google.protobuf.ByteString getIntendedAudienceBytes()
         Text briefly identifying the intended audience of the API. Changes to this
 value will not affect the revision.
        string intended_audience = 11;
        Specified by:
        getIntendedAudienceBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for intendedAudience.

      • 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;
        Specified by:
        getAccessGuidance in interface ApiDeploymentOrBuilder
        Returns:
        The accessGuidance.

      • getAccessGuidanceBytes

        public com.google.protobuf.ByteString getAccessGuidanceBytes()
         Text briefly describing how to access the endpoint. Changes to this value
 will not affect the revision.
        string access_guidance = 12;
        Specified by:
        getAccessGuidanceBytes in interface ApiDeploymentOrBuilder
        Returns:
        The bytes for accessGuidance.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: ApiDeploymentOrBuilder
         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;
        Specified by:
        getLabelsCount in interface ApiDeploymentOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface ApiDeploymentOrBuilder

      • 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;
        Specified by:
        getLabelsMap in interface ApiDeploymentOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface ApiDeploymentOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface ApiDeploymentOrBuilder

      • getAnnotationsCount

        public int getAnnotationsCount()
        Description copied from interface: ApiDeploymentOrBuilder
         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;
        Specified by:
        getAnnotationsCount in interface ApiDeploymentOrBuilder

      • containsAnnotations

        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;
        Specified by:
        containsAnnotations in interface ApiDeploymentOrBuilder

      • 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;
        Specified by:
        getAnnotationsMap in interface ApiDeploymentOrBuilder

      • getAnnotationsOrDefault

        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;
        Specified by:
        getAnnotationsOrDefault in interface ApiDeploymentOrBuilder

      • getAnnotationsOrThrow

        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;
        Specified by:
        getAnnotationsOrThrow in interface ApiDeploymentOrBuilder

      • 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 ApiDeployment parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ApiDeployment parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ApiDeployment.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ApiDeployment.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ApiDeployment.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ApiDeployment getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<ApiDeployment> 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 ApiDeployment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder