Package com.google.api

Class ResourceDescriptor

  • All Implemented Interfaces:
    ResourceDescriptorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ResourceDescriptor
extends com.google.protobuf.GeneratedMessageV3
implements ResourceDescriptorOrBuilder
     A simple descriptor of a resource type.
 ResourceDescriptor annotates a resource message (either by means of a
 protobuf annotation or use in the service config), and associates the
 resource's schema, the resource type, and the pattern of the resource name.
 Example:
     message Topic {
       // Indicates this message defines a resource schema.
       // Declares the resource type in the format of {service}/{kind}.
       // For Kubernetes resources, the format is {api group}/{kind}.
       option (google.api.resource) = {
         type: "pubsub.googleapis.com/Topic"
         pattern: "projects/{project}/topics/{topic}"
       };
     }
 The ResourceDescriptor Yaml config will look like:
     resources:
     - type: "pubsub.googleapis.com/Topic"
       pattern: "projects/{project}/topics/{topic}"
 Sometimes, resources have multiple patterns, typically because they can
 live under multiple parents.
 Example:
     message LogEntry {
       option (google.api.resource) = {
         type: "logging.googleapis.com/LogEntry"
         pattern: "projects/{project}/logs/{log}"
         pattern: "folders/{folder}/logs/{log}"
         pattern: "organizations/{organization}/logs/{log}"
         pattern: "billingAccounts/{billing_account}/logs/{log}"
       };
     }
 The ResourceDescriptor Yaml config will look like:
     resources:
     - type: 'logging.googleapis.com/LogEntry'
       pattern: "projects/{project}/logs/{log}"
       pattern: "folders/{folder}/logs/{log}"
       pattern: "organizations/{organization}/logs/{log}"
       pattern: "billingAccounts/{billing_account}/logs/{log}"
    Protobuf type google.api.ResourceDescriptor
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ResourceDescriptor.Builder
      A simple descriptor of a resource type.
      static class  ResourceDescriptor.History
      A description of the historical or future-looking state of the resource pattern.
      static class  ResourceDescriptor.Style
      A flag representing a specific style that a resource claims to conform to.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getType

        public String getType()
         The resource type. It must be in the format of
 {service_name}/{resource_type_kind}. The `resource_type_kind` must be
 singular and must not include version numbers.
 Example: `storage.googleapis.com/Bucket`
 The value of the resource_type_kind must follow the regular expression
 /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
 should use PascalCase (UpperCamelCase). The maximum number of
 characters allowed for the `resource_type_kind` is 100.
        string type = 1;
        Specified by:
        getType in interface ResourceDescriptorOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The resource type. It must be in the format of
 {service_name}/{resource_type_kind}. The `resource_type_kind` must be
 singular and must not include version numbers.
 Example: `storage.googleapis.com/Bucket`
 The value of the resource_type_kind must follow the regular expression
 /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
 should use PascalCase (UpperCamelCase). The maximum number of
 characters allowed for the `resource_type_kind` is 100.
        string type = 1;
        Specified by:
        getTypeBytes in interface ResourceDescriptorOrBuilder
        Returns:
        The bytes for type.

      • getPatternList

        public com.google.protobuf.ProtocolStringList getPatternList()
         Optional. The relative resource name pattern associated with this resource
 type. The DNS prefix of the full resource name shouldn't be specified here.
 The path pattern must follow the syntax, which aligns with HTTP binding
 syntax:
     Template = Segment { "/" Segment } ;
     Segment = LITERAL | Variable ;
     Variable = "{" LITERAL "}" ;
 Examples:
     - "projects/{project}/topics/{topic}"
     - "projects/{project}/knowledgeBases/{knowledge_base}"
 The components in braces correspond to the IDs for each resource in the
 hierarchy. It is expected that, if multiple patterns are provided,
 the same component name (e.g. "project") refers to IDs of the same
 type of resource.
        repeated string pattern = 2;
        Specified by:
        getPatternList in interface ResourceDescriptorOrBuilder
        Returns:
        A list containing the pattern.

      • getPatternCount

        public int getPatternCount()
         Optional. The relative resource name pattern associated with this resource
 type. The DNS prefix of the full resource name shouldn't be specified here.
 The path pattern must follow the syntax, which aligns with HTTP binding
 syntax:
     Template = Segment { "/" Segment } ;
     Segment = LITERAL | Variable ;
     Variable = "{" LITERAL "}" ;
 Examples:
     - "projects/{project}/topics/{topic}"
     - "projects/{project}/knowledgeBases/{knowledge_base}"
 The components in braces correspond to the IDs for each resource in the
 hierarchy. It is expected that, if multiple patterns are provided,
 the same component name (e.g. "project") refers to IDs of the same
 type of resource.
        repeated string pattern = 2;
        Specified by:
        getPatternCount in interface ResourceDescriptorOrBuilder
        Returns:
        The count of pattern.

      • getPattern

        public String getPattern​(int index)
         Optional. The relative resource name pattern associated with this resource
 type. The DNS prefix of the full resource name shouldn't be specified here.
 The path pattern must follow the syntax, which aligns with HTTP binding
 syntax:
     Template = Segment { "/" Segment } ;
     Segment = LITERAL | Variable ;
     Variable = "{" LITERAL "}" ;
 Examples:
     - "projects/{project}/topics/{topic}"
     - "projects/{project}/knowledgeBases/{knowledge_base}"
 The components in braces correspond to the IDs for each resource in the
 hierarchy. It is expected that, if multiple patterns are provided,
 the same component name (e.g. "project") refers to IDs of the same
 type of resource.
        repeated string pattern = 2;
        Specified by:
        getPattern in interface ResourceDescriptorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The pattern at the given index.

      • getPatternBytes

        public com.google.protobuf.ByteString getPatternBytes​(int index)
         Optional. The relative resource name pattern associated with this resource
 type. The DNS prefix of the full resource name shouldn't be specified here.
 The path pattern must follow the syntax, which aligns with HTTP binding
 syntax:
     Template = Segment { "/" Segment } ;
     Segment = LITERAL | Variable ;
     Variable = "{" LITERAL "}" ;
 Examples:
     - "projects/{project}/topics/{topic}"
     - "projects/{project}/knowledgeBases/{knowledge_base}"
 The components in braces correspond to the IDs for each resource in the
 hierarchy. It is expected that, if multiple patterns are provided,
 the same component name (e.g. "project") refers to IDs of the same
 type of resource.
        repeated string pattern = 2;
        Specified by:
        getPatternBytes in interface ResourceDescriptorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pattern at the given index.

      • getNameField

        public String getNameField()
         Optional. The field on the resource that designates the resource name
 field. If omitted, this is assumed to be "name".
        string name_field = 3;
        Specified by:
        getNameField in interface ResourceDescriptorOrBuilder
        Returns:
        The nameField.

      • getNameFieldBytes

        public com.google.protobuf.ByteString getNameFieldBytes()
         Optional. The field on the resource that designates the resource name
 field. If omitted, this is assumed to be "name".
        string name_field = 3;
        Specified by:
        getNameFieldBytes in interface ResourceDescriptorOrBuilder
        Returns:
        The bytes for nameField.

      • getHistoryValue

        public int getHistoryValue()
         Optional. The historical or future-looking state of the resource pattern.
 Example:
     // The InspectTemplate message originally only supported resource
     // names with organization, and project was added later.
     message InspectTemplate {
       option (google.api.resource) = {
         type: "dlp.googleapis.com/InspectTemplate"
         pattern:
         "organizations/{organization}/inspectTemplates/{inspect_template}"
         pattern: "projects/{project}/inspectTemplates/{inspect_template}"
         history: ORIGINALLY_SINGLE_PATTERN
       };
     }
        .google.api.ResourceDescriptor.History history = 4;
        Specified by:
        getHistoryValue in interface ResourceDescriptorOrBuilder
        Returns:
        The enum numeric value on the wire for history.

      • getHistory

        public ResourceDescriptor.History getHistory()
         Optional. The historical or future-looking state of the resource pattern.
 Example:
     // The InspectTemplate message originally only supported resource
     // names with organization, and project was added later.
     message InspectTemplate {
       option (google.api.resource) = {
         type: "dlp.googleapis.com/InspectTemplate"
         pattern:
         "organizations/{organization}/inspectTemplates/{inspect_template}"
         pattern: "projects/{project}/inspectTemplates/{inspect_template}"
         history: ORIGINALLY_SINGLE_PATTERN
       };
     }
        .google.api.ResourceDescriptor.History history = 4;
        Specified by:
        getHistory in interface ResourceDescriptorOrBuilder
        Returns:
        The history.

      • getPlural

        public String getPlural()
         The plural name used in the resource name and permission names, such as
 'projects' for the resource name of 'projects/{project}' and the permission
 name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
 concept of the `plural` field in k8s CRD spec
 https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
 Note: The plural form is required even for singleton resources. See
 https://aip.dev/156
        string plural = 5;
        Specified by:
        getPlural in interface ResourceDescriptorOrBuilder
        Returns:
        The plural.

      • getPluralBytes

        public com.google.protobuf.ByteString getPluralBytes()
         The plural name used in the resource name and permission names, such as
 'projects' for the resource name of 'projects/{project}' and the permission
 name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
 concept of the `plural` field in k8s CRD spec
 https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
 Note: The plural form is required even for singleton resources. See
 https://aip.dev/156
        string plural = 5;
        Specified by:
        getPluralBytes in interface ResourceDescriptorOrBuilder
        Returns:
        The bytes for plural.

      • getSingular

        public String getSingular()
         The same concept of the `singular` field in k8s CRD spec
 https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
 Such as "project" for the `resourcemanager.googleapis.com/Project` type.
        string singular = 6;
        Specified by:
        getSingular in interface ResourceDescriptorOrBuilder
        Returns:
        The singular.

      • getSingularBytes

        public com.google.protobuf.ByteString getSingularBytes()
         The same concept of the `singular` field in k8s CRD spec
 https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
 Such as "project" for the `resourcemanager.googleapis.com/Project` type.
        string singular = 6;
        Specified by:
        getSingularBytes in interface ResourceDescriptorOrBuilder
        Returns:
        The bytes for singular.

      • getStyleList

        public List<ResourceDescriptor.Style> getStyleList()
         Style flag(s) for this resource.
 These indicate that a resource is expected to conform to a given
 style. See the specific style flags for additional information.
        repeated .google.api.ResourceDescriptor.Style style = 10;
        Specified by:
        getStyleList in interface ResourceDescriptorOrBuilder
        Returns:
        A list containing the style.

      • getStyleCount

        public int getStyleCount()
         Style flag(s) for this resource.
 These indicate that a resource is expected to conform to a given
 style. See the specific style flags for additional information.
        repeated .google.api.ResourceDescriptor.Style style = 10;
        Specified by:
        getStyleCount in interface ResourceDescriptorOrBuilder
        Returns:
        The count of style.

      • getStyle

        public ResourceDescriptor.Style getStyle​(int index)
         Style flag(s) for this resource.
 These indicate that a resource is expected to conform to a given
 style. See the specific style flags for additional information.
        repeated .google.api.ResourceDescriptor.Style style = 10;
        Specified by:
        getStyle in interface ResourceDescriptorOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The style at the given index.

      • getStyleValueList

        public List<Integer> getStyleValueList()
         Style flag(s) for this resource.
 These indicate that a resource is expected to conform to a given
 style. See the specific style flags for additional information.
        repeated .google.api.ResourceDescriptor.Style style = 10;
        Specified by:
        getStyleValueList in interface ResourceDescriptorOrBuilder
        Returns:
        A list containing the enum numeric values on the wire for style.

      • getStyleValue

        public int getStyleValue​(int index)
         Style flag(s) for this resource.
 These indicate that a resource is expected to conform to a given
 style. See the specific style flags for additional information.
        repeated .google.api.ResourceDescriptor.Style style = 10;
        Specified by:
        getStyleValue in interface ResourceDescriptorOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of style at the given index.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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