Class ResourceDescriptor

public sealed class ResourceDescriptor : Protobuf.IMessage<ResourceDescriptor>, Protobuf.IBufferMessage

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"

Inheritance

Object > ResourceDescriptor

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

ResourceDescriptor()

public ResourceDescriptor()

ResourceDescriptor(ResourceDescriptor)

public ResourceDescriptor(ResourceDescriptor other)
Parameter
TypeNameDescription
ResourceDescriptorother

Fields

HistoryFieldNumber

public const int HistoryFieldNumber = 4

Field number for the "history" field.

Field Value
TypeDescription
Int32

NameFieldFieldNumber

public const int NameFieldFieldNumber = 3

Field number for the "name_field" field.

Field Value
TypeDescription
Int32

PatternFieldNumber

public const int PatternFieldNumber = 2

Field number for the "pattern" field.

Field Value
TypeDescription
Int32

PluralFieldNumber

public const int PluralFieldNumber = 5

Field number for the "plural" field.

Field Value
TypeDescription
Int32

SingularFieldNumber

public const int SingularFieldNumber = 6

Field number for the "singular" field.

Field Value
TypeDescription
Int32

StyleFieldNumber

public const int StyleFieldNumber = 10

Field number for the "style" field.

Field Value
TypeDescription
Int32

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
TypeDescription
Int32

Properties

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

History

public ResourceDescriptor.Types.History History { get; set; }

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

Property Value
TypeDescription
ResourceDescriptor.Types.History

NameField

public string NameField { get; set; }

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

Property Value
TypeDescription
String

Parser

public static Protobuf.MessageParser<ResourceDescriptor> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<ResourceDescriptor>

Pattern

public Protobuf.Collections.RepeatedField<string> Pattern { get; }

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.

Property Value
TypeDescription
Protobuf.Collections.RepeatedField<String>

Plural

public string Plural { get; set; }

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

Property Value
TypeDescription
String

Singular

public string Singular { get; set; }

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.

Property Value
TypeDescription
String

Style

public Protobuf.Collections.RepeatedField<ResourceDescriptor.Types.Style> Style { get; }

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.

Property Value
TypeDescription
Protobuf.Collections.RepeatedField<ResourceDescriptor.Types.Style>

Type

public string Type { get; set; }

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.

Property Value
TypeDescription
String

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public ResourceDescriptor Clone()
Returns
TypeDescription
ResourceDescriptor

Equals(ResourceDescriptor)

public bool Equals(ResourceDescriptor other)
Parameter
TypeNameDescription
ResourceDescriptorother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
TypeNameDescription
Objectother
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(ResourceDescriptor)

public void MergeFrom(ResourceDescriptor other)
Parameter
TypeNameDescription
ResourceDescriptorother

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
TypeNameDescription
Protobuf.CodedInputStreaminput

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
TypeNameDescription
Protobuf.CodedOutputStreamoutput

Implements