Package com.google.cloud.apigeeregistry.v1

Class Api

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

    • 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

      • getName

        public String getName()
         Resource name.
        string name = 1;
        Specified by:
        getName in interface ApiOrBuilder
        Returns:
        The name.

      • getNameBytes

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

      • getDisplayName

        public String getDisplayName()
         Human-meaningful name.
        string display_name = 2;
        Specified by:
        getDisplayName in interface ApiOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

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

      • getDescription

        public String getDescription()
         A detailed description.
        string description = 3;
        Specified by:
        getDescription in interface ApiOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

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

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Creation timestamp.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface ApiOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Creation timestamp.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface ApiOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Creation timestamp.
        .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface ApiOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Last update timestamp.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ApiOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Last update timestamp.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ApiOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Last update timestamp.
        .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ApiOrBuilder

      • 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;
        Specified by:
        getAvailability in interface ApiOrBuilder
        Returns:
        The availability.

      • getAvailabilityBytes

        public com.google.protobuf.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;
        Specified by:
        getAvailabilityBytes in interface ApiOrBuilder
        Returns:
        The bytes for availability.

      • getRecommendedVersion

        public String getRecommendedVersion()
         The recommended version of the API.
 Format: `apis/{api}/versions/{version}`
        string recommended_version = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getRecommendedVersion in interface ApiOrBuilder
        Returns:
        The recommendedVersion.

      • getRecommendedVersionBytes

        public com.google.protobuf.ByteString getRecommendedVersionBytes()
         The recommended version of the API.
 Format: `apis/{api}/versions/{version}`
        string recommended_version = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getRecommendedVersionBytes in interface ApiOrBuilder
        Returns:
        The bytes for recommendedVersion.

      • getRecommendedDeployment

        public String getRecommendedDeployment()
         The recommended deployment of the API.
 Format: `apis/{api}/deployments/{deployment}`
        string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
        Specified by:
        getRecommendedDeployment in interface ApiOrBuilder
        Returns:
        The recommendedDeployment.

      • getRecommendedDeploymentBytes

        public com.google.protobuf.ByteString getRecommendedDeploymentBytes()
         The recommended deployment of the API.
 Format: `apis/{api}/deployments/{deployment}`
        string recommended_deployment = 8 [(.google.api.resource_reference) = { ... }
        Specified by:
        getRecommendedDeploymentBytes in interface ApiOrBuilder
        Returns:
        The bytes for recommendedDeployment.

      • getLabelsCount

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

      • 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 = 9;
        Specified by:
        containsLabels in interface ApiOrBuilder

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

      • 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 = 9;
        Specified by:
        getLabelsOrDefault in interface ApiOrBuilder

      • 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 = 9;
        Specified by:
        getLabelsOrThrow in interface ApiOrBuilder

      • getAnnotationsCount

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

      • 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 = 10;
        Specified by:
        containsAnnotations in interface ApiOrBuilder

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

      • 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 = 10;
        Specified by:
        getAnnotationsOrDefault in interface ApiOrBuilder

      • 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 = 10;
        Specified by:
        getAnnotationsOrThrow in interface ApiOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

        public static Api parseDelimitedFrom​(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Throws:
        IOException

      • parseFrom

        public static Api parseFrom​(com.google.protobuf.CodedInputStream input)
                     throws IOException
        Throws:
        IOException

      • parseFrom

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

      • newBuilderForType

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

      • newBuilder

        public static Api.Builder newBuilder​(Api prototype)

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Api getDefaultInstance()

      • parser

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

      • getParserForType

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