Package com.google.api

Interface ResourceDescriptorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
ResourceDescriptor, ResourceDescriptor.Builder
public interface ResourceDescriptorOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ResourceDescriptor.History
    getHistory()
    Optional.
    int
    getHistoryValue()
    Optional.
    String
    getNameField()
    Optional.
    com.google.protobuf.ByteString
    getNameFieldBytes()
    Optional.
    String
    getPattern(int index)
    Optional.
    com.google.protobuf.ByteString
    getPatternBytes(int index)
    Optional.
    int
    getPatternCount()
    Optional.
    List<String>
    getPatternList()
    Optional.
    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'.
    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'.
    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.
    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.
    ResourceDescriptor.Style
    getStyle(int index)
    Style flag(s) for this resource.
    int
    getStyleCount()
    Style flag(s) for this resource.
    List<ResourceDescriptor.Style>
    getStyleList()
    Style flag(s) for this resource.
    int
    getStyleValue(int index)
    Style flag(s) for this resource.
    List<Integer>
    getStyleValueList()
    Style flag(s) for this resource.
    String
    getType()
    The resource type.
    com.google.protobuf.ByteString
    getTypeBytes()
    The resource type.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getType

      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 [json_name = "type"];
      Returns:
      The type.

    • getTypeBytes

      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 [json_name = "type"];
      Returns:
      The bytes for type.

    • getPatternList

      List<String> 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 [json_name = "pattern"];
      Returns:
      A list containing the pattern.

    • getPatternCount

      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 [json_name = "pattern"];
      Returns:
      The count of pattern.

    • getPattern

      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 [json_name = "pattern"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The pattern at the given index.

    • getPatternBytes

      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 [json_name = "pattern"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The pattern at the given index.

    • getNameField

      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 [json_name = "nameField"];
      Returns:
      The nameField.

    • getNameFieldBytes

      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 [json_name = "nameField"];
      Returns:
      The bytes for nameField.

    • getHistoryValue

      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 [json_name = "history"];
      Returns:
      The enum numeric value on the wire for history.

    • getHistory

      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 [json_name = "history"];
      Returns:
      The history.

    • getPlural

      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'. One exception
 to this is for Nested Collections that have stuttering names, as defined
 in [AIP-122](https://google.aip.dev/122#nested-collections), where the
 collection ID in the resource name pattern does not necessarily directly
 match the `plural` value.

 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 [json_name = "plural"];
      Returns:
      The plural.

    • getPluralBytes

      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'. One exception
 to this is for Nested Collections that have stuttering names, as defined
 in [AIP-122](https://google.aip.dev/122#nested-collections), where the
 collection ID in the resource name pattern does not necessarily directly
 match the `plural` value.

 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 [json_name = "plural"];
      Returns:
      The bytes for plural.

    • getSingular

      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 [json_name = "singular"];
      Returns:
      The singular.

    • getSingularBytes

      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 [json_name = "singular"];
      Returns:
      The bytes for singular.

    • getStyleList

      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 [json_name = "style"];
      Returns:
      A list containing the style.

    • getStyleCount

      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 [json_name = "style"];
      Returns:
      The count of style.

    • getStyle

      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 [json_name = "style"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The style at the given index.

    • getStyleValueList

      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 [json_name = "style"];
      Returns:
      A list containing the enum numeric values on the wire for style.

    • getStyleValue

      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 [json_name = "style"];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of style at the given index.