Package com.google.cloud.apigeeregistry.v1

Interface ApiDeploymentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ApiDeployment, ApiDeployment.Builder
    public interface ApiDeploymentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Resource name.
        string name = 1;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Resource name.
        string name = 1;
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         Human-meaningful name.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         Human-meaningful name.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getDescription

        String getDescription()
         A detailed description.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         A detailed description.
        string description = 3;
        Returns:
        The bytes for description.

      • getRevisionId

        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];
        Returns:
        The revisionId.

      • getRevisionIdBytes

        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];
        Returns:
        The bytes for revisionId.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Creation timestamp; when the deployment resource was created.
        .google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        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];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        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];

      • hasRevisionCreateTime

        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];
        Returns:
        Whether the revisionCreateTime field is set.

      • getRevisionCreateTime

        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];
        Returns:
        The revisionCreateTime.

      • getRevisionCreateTimeOrBuilder

        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];

      • hasRevisionUpdateTime

        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];
        Returns:
        Whether the revisionUpdateTime field is set.

      • getRevisionUpdateTime

        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];
        Returns:
        The revisionUpdateTime.

      • getRevisionUpdateTimeOrBuilder

        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];

      • getApiSpecRevision

        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) = { ... }
        Returns:
        The apiSpecRevision.

      • getApiSpecRevisionBytes

        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) = { ... }
        Returns:
        The bytes for apiSpecRevision.

      • getEndpointUri

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

      • getEndpointUriBytes

        com.google.protobuf.ByteString getEndpointUriBytes()
         The address where the deployment is serving. Changes to this value will
 update the revision.
        string endpoint_uri = 9;
        Returns:
        The bytes for endpointUri.

      • getExternalChannelUri

        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;
        Returns:
        The externalChannelUri.

      • getExternalChannelUriBytes

        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;
        Returns:
        The bytes for externalChannelUri.

      • getIntendedAudience

        String getIntendedAudience()
         Text briefly identifying the intended audience of the API. Changes to this
 value will not affect the revision.
        string intended_audience = 11;
        Returns:
        The intendedAudience.

      • getIntendedAudienceBytes

        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;
        Returns:
        The bytes for intendedAudience.

      • getAccessGuidance

        String getAccessGuidance()
         Text briefly describing how to access the endpoint. Changes to this value
 will not affect the revision.
        string access_guidance = 12;
        Returns:
        The accessGuidance.

      • getAccessGuidanceBytes

        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;
        Returns:
        The bytes for accessGuidance.

      • getLabelsCount

        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;

      • containsLabels

        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;

      • getLabelsMap

        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 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 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;

      • getAnnotationsCount

        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;

      • containsAnnotations

        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;

      • getAnnotationsMap

        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 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 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;