Class ResourceDescriptor

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

System.Object

ResourceDescriptor

Implements

IMessage<ResourceDescriptor>

IMessage

System.IEquatable<ResourceDescriptor>

IDeepCloneable<ResourceDescriptor>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api

Assembly: Google.Api.CommonProtos.dll

Syntax

public sealed class ResourceDescriptor : IMessage<ResourceDescriptor>, IMessage, IEquatable<ResourceDescriptor>, IDeepCloneable<ResourceDescriptor>

Constructors

ResourceDescriptor()

Declaration

public ResourceDescriptor()

ResourceDescriptor(ResourceDescriptor)

Declaration

public ResourceDescriptor(ResourceDescriptor other)

Parameters

Type	Name	Description
ResourceDescriptor	other

Fields

HistoryFieldNumber

Field number for the "history" field.

Declaration

public const int HistoryFieldNumber = 4

Field Value

Type	Description
System.Int32

NameFieldFieldNumber

Field number for the "name_field" field.

Declaration

public const int NameFieldFieldNumber = 3

Field Value

Type	Description
System.Int32

PatternFieldNumber

Field number for the "pattern" field.

Declaration

public const int PatternFieldNumber = 2

Field Value

Type	Description
System.Int32

PluralFieldNumber

Field number for the "plural" field.

Declaration

public const int PluralFieldNumber = 5

Field Value

Type	Description
System.Int32

SingularFieldNumber

Field number for the "singular" field.

Declaration

public const int SingularFieldNumber = 6

Field Value

Type	Description
System.Int32

TypeFieldNumber

Field number for the "type" field.

Declaration

public const int TypeFieldNumber = 1

Field Value

Type	Description
System.Int32

Properties

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

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

Declaration

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

Property Value

Type	Description
ResourceDescriptor.Types.History

NameField

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

Declaration

public string NameField { get; set; }

Property Value

Type	Description
System.String

Parser

Declaration

public static MessageParser<ResourceDescriptor> Parser { get; }

Property Value

Type	Description
MessageParser<ResourceDescriptor>

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.

Declaration

public RepeatedField<string> Pattern { get; }

Property Value

Type	Description
RepeatedField<System.String>

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/

Declaration

public string Plural { get; set; }

Property Value

Type	Description
System.String

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.

Declaration

public string Singular { get; set; }

Property Value

Type	Description
System.String

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.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String

Methods

CalculateSize()

Declaration

public int CalculateSize()

Returns

Type	Description
System.Int32

Implements

IMessage.CalculateSize()

Clone()

Declaration

public ResourceDescriptor Clone()

Returns

Type	Description
ResourceDescriptor

Implements

IDeepCloneable<T>.Clone()

Equals(ResourceDescriptor)

Declaration

public bool Equals(ResourceDescriptor other)

Parameters

Type	Name	Description
ResourceDescriptor	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

MergeFrom(ResourceDescriptor)

Declaration

public void MergeFrom(ResourceDescriptor other)

Parameters

Type	Name	Description
ResourceDescriptor	other

Implements

IMessage<T>.MergeFrom(T)

MergeFrom(CodedInputStream)

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Implements

IMessage.MergeFrom(CodedInputStream)

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output

Implements

IMessage.WriteTo(CodedOutputStream)

Explicit Interface Implementations

IMessage.Descriptor

Declaration

MessageDescriptor IMessage.Descriptor { get; }

Returns

Type	Description
MessageDescriptor

Implements

IMessage.Descriptor