Package com.google.cloud.apigeeregistry.v1

Interface ApiSpecOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ApiSpec, ApiSpec.Builder
    public interface ApiSpecOrBuilder
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.

      • getFilename

        String getFilename()
         A possibly-hierarchical name used to refer to the spec from other specs.
        string filename = 2;
        Returns:
        The filename.

      • getFilenameBytes

        com.google.protobuf.ByteString getFilenameBytes()
         A possibly-hierarchical name used to refer to the spec from other specs.
        string filename = 2;
        Returns:
        The bytes for filename.

      • 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 spec.
 A new revision is committed whenever the spec 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 spec.
 A new revision is committed whenever the spec 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 spec 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 spec 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 spec 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];

      • getMimeType

        String getMimeType()
         A style (format) descriptor for this spec that is specified as a Media Type
 (https://en.wikipedia.org/wiki/Media_type). Possible values include
 `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and
 `application/vnd.apigee.graphql`, with possible suffixes representing
 compression types. These hypothetical names are defined in the vendor tree
 defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
 Content types can specify compression. Currently only GZip compression is
 supported (indicated with "+gzip").
        string mime_type = 8;
        Returns:
        The mimeType.

      • getMimeTypeBytes

        com.google.protobuf.ByteString getMimeTypeBytes()
         A style (format) descriptor for this spec that is specified as a Media Type
 (https://en.wikipedia.org/wiki/Media_type). Possible values include
 `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and
 `application/vnd.apigee.graphql`, with possible suffixes representing
 compression types. These hypothetical names are defined in the vendor tree
 defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final.
 Content types can specify compression. Currently only GZip compression is
 supported (indicated with "+gzip").
        string mime_type = 8;
        Returns:
        The bytes for mimeType.

      • getSizeBytes

        int getSizeBytes()
         Output only. The size of the spec file in bytes. If the spec is gzipped, this is the
 size of the uncompressed spec.
        int32 size_bytes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The sizeBytes.

      • getHash

        String getHash()
         Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is
 the hash of the uncompressed spec.
        string hash = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The hash.

      • getHashBytes

        com.google.protobuf.ByteString getHashBytes()
         Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is
 the hash of the uncompressed spec.
        string hash = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for hash.

      • getSourceUri

        String getSourceUri()
         The original source URI of the spec (if one exists).
 This is an external location that can be used for reference purposes
 but which may not be authoritative since this external resource may
 change after the spec is retrieved.
        string source_uri = 11;
        Returns:
        The sourceUri.

      • getSourceUriBytes

        com.google.protobuf.ByteString getSourceUriBytes()
         The original source URI of the spec (if one exists).
 This is an external location that can be used for reference purposes
 but which may not be authoritative since this external resource may
 change after the spec is retrieved.
        string source_uri = 11;
        Returns:
        The bytes for sourceUri.

      • getContents

        com.google.protobuf.ByteString getContents()
         Input only. The contents of the spec.
 Provided by API callers when specs are created or updated.
 To access the contents of a spec, use GetApiSpecContents.
        bytes contents = 12 [(.google.api.field_behavior) = INPUT_ONLY];
        Returns:
        The contents.

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