Method: Google::Api::ResourceDescriptor#pattern

Defined in:

proto_docs/google/api/resource.rb

#pattern ⇒ ::Array<::String>

Returns 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.

Returns:

• (::Array<::String>) —

  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.

# File 'proto_docs/google/api/resource.rb', line 143

class ResourceDescriptor
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A description of the historical or future-looking state of the
  # resource pattern.
  module History
    # The "unset" value.
    HISTORY_UNSPECIFIED = 0

    # The resource originally had one pattern and launched as such, and
    # additional patterns were added later.
    ORIGINALLY_SINGLE_PATTERN = 1

    # The resource has one pattern, but the API owner expects to add more
    # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
    # that from being necessary once there are multiple patterns.)
    FUTURE_MULTI_PATTERN = 2
  end

  # A flag representing a specific style that a resource claims to conform to.
  module Style
    # The unspecified value. Do not use.
    STYLE_UNSPECIFIED = 0

    # This resource is intended to be "declarative-friendly".
    #
    # Declarative-friendly resources must be more strictly consistent, and
    # setting this to true communicates to tools that this resource should
    # adhere to declarative-friendly expectations.
    #
    # Note: This is used by the API linter (linter.aip.dev) to enable
    # additional checks.
    DECLARATIVE_FRIENDLY = 1
  end
end