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"
    name_descriptor: {
      pattern: "projects/{project}/topics/{topic}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
    }
  };
}

The ResourceDescriptor Yaml config will look like:
resources:

  • type: "pubsub.googleapis.com/Topic"
    name_descriptor:
    • pattern: "projects/{project}/topics/{topic}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
      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"
      name_descriptor: {
      pattern: "projects/{project}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
      }
      name_descriptor: {
      pattern: "folders/{folder}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
      parent_name_extractor: "folders/{folder}"
      }
      name_descriptor: {
      pattern: "organizations/{organization}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Organization"
      parent_name_extractor: "organizations/{organization}"
      }
      name_descriptor: {
      pattern: "billingAccounts/{billing_account}/logs/{log}"
      parent_type: "billing.googleapis.com/BillingAccount"
      parent_name_extractor: "billingAccounts/{billing_account}"
      }
      };
      }
      The ResourceDescriptor Yaml config will look like:
      resources:
  • type: 'logging.googleapis.com/LogEntry'
    name_descriptor:
    • pattern: "projects/{project}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      parent_name_extractor: "projects/{project}"
    • pattern: "folders/{folder}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
      parent_name_extractor: "folders/{folder}"
    • pattern: "organizations/{organization}/logs/{log}"
      parent_type: "cloudresourcemanager.googleapis.com/Organization"
      parent_name_extractor: "organizations/{organization}"
    • pattern: "billingAccounts/{billing_account}/logs/{log}"
      parent_type: "billing.googleapis.com/BillingAccount"
      parent_name_extractor: "billingAccounts/{billing_account}"
      For flexible resources, the resource name doesn't contain parent names, but
      the resource itself has parents for policy evaluation.
      Example:
      message Shelf {
      option (google.api.resource) = {
      type: "library.googleapis.com/Shelf"
      name_descriptor: {
      pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
      }
      name_descriptor: {
      pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"
      }
      };
      }
      The ResourceDescriptor Yaml config will look like:
      resources:
  • type: 'library.googleapis.com/Shelf'
    name_descriptor:
    • pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Project"
    • pattern: "shelves/{shelf}"
      parent_type: "cloudresourcemanager.googleapis.com/Folder"

Generated from protobuf message google.api.ResourceDescriptor

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 

Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::clear()
     

    Clear all containing fields.

    • return
    public Google\Protobuf\Internal\Message::discardUnknownFields()
     

    Clear all unknown fields previously parsed.

    • return
    public 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
      };
    }
    

    Generated from protobuf field .google.api.ResourceDescriptor.History history = 4;

    • return int
    public getNameField()
     

    Optional. The field on the resource that designates the resource name
    field. If omitted, this is assumed to be "name".

    Generated from protobuf field string name_field = 3;

    • return string
    public getPattern()
     

    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.

    Generated from protobuf field repeated string pattern = 2;

    public getPlural()
     

    The plural name used in the resource name, such as 'projects' for
    the name of 'projects/{project}'. 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/

    Generated from protobuf field string plural = 5;

    • return string
    public 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.

    Generated from protobuf field string singular = 6;

    • return string
    public 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.

    Generated from protobuf field string type = 1;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     
    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
     

    Merges the contents of the specified message into current message.

    This method merges the contents of the specified message into the
    current message. Singular fields that are set in the specified message
    overwrite the corresponding fields in the current message. Repeated
    fields are appended. Map fields key-value pairs are overwritten.
    Singular/Oneof sub-messages are recursively merged. All overwritten
    sub-messages are deep-copied.

    • return
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
     

    Parses a json string to protobuf message.

    This function takes a string in the json wire format, matching the
    encoding output by serializeToJsonString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
     

    Parses a protocol buffer contained in a string.

    This function takes a string in the (non-human-readable) binary wire
    format, matching the encoding output by serializeToString().
    See mergeFrom() for merging behavior, if the field is already set in the
    specified message.

    • return
    • throws Exception Invalid data.
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
     
    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     

    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     
    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     

    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setHistory( $var)
     

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

    Generated from protobuf field .google.api.ResourceDescriptor.History history = 4;

    • return $this
    public setNameField( $var)
     

    Optional. The field on the resource that designates the resource name
    field. If omitted, this is assumed to be "name".

    Generated from protobuf field string name_field = 3;

    • return $this
    public setPattern( $var)
     

    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.

    Generated from protobuf field repeated string pattern = 2;

    • return $this
    public setPlural( $var)
     

    The plural name used in the resource name, such as 'projects' for
    the name of 'projects/{project}'. 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/

    Generated from protobuf field string plural = 5;

    • return $this
    public setSingular( $var)
     

    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.

    Generated from protobuf field string singular = 6;

    • return $this
    public setType( $var)
     

    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.

    Generated from protobuf field string type = 1;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
     

    Populates the message from a user-supplied PHP array. Array keys
    correspond to Message properties and nested message properties.

    Example:

    $message->mergeFromArray([
        'name' => 'This is a message name',
        'interval' => [
             'startTime' => time() - 60,
             'endTime' => time(),
        ]
    ]);
    

    This method will trigger an error if it is passed data that cannot
    be converted to the correct type. For example, a StringValue field
    must receive data that is either a string or a StringValue object.

    • return
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $history
     

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

    Generated from protobuf field .google.api.ResourceDescriptor.History history = 4;

    private $name_field
     

    Optional. The field on the resource that designates the resource name
    field. If omitted, this is assumed to be "name".

    Generated from protobuf field string name_field = 3;

    private $pattern
     

    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.

    Generated from protobuf field repeated string pattern = 2;

    private $plural
     

    The plural name used in the resource name, such as 'projects' for
    the name of 'projects/{project}'. 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/

    Generated from protobuf field string plural = 5;

    private $singular
     

    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.

    Generated from protobuf field string singular = 6;

    private $type
     

    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.

    Generated from protobuf field string type = 1;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $ignore_unknown, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     
    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     
    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     
    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array, $ignore_unknown)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     

    Tries to normalize the elements in $value into a provided protobuf
    wrapper type $class. If $value is any type other than array, we do
    not do any conversion, and instead rely on the existing protobuf
    type checking. If $value is an array, we process each element and
    try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       

      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         
        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         
        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         
        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         
        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         

        Tries to normalize the elements in $value into a provided protobuf
        wrapper type $class. If $value is any type other than array, we do
        not do any conversion, and instead rely on the existing protobuf
        type checking. If $value is an array, we process each element and
        try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           

          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             
            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only