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" pattern: "projects/{project}/topics/{topic}" }; }

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" pattern: "projects/{project}/logs/{log}" pattern: "organizations/{organization}/logs/{log}" pattern: "folders/{folder}/logs/{log}" pattern: "billingAccounts/{billing_account}/logs/{log}" }; }

Inheritance
System.Object
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

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 valid resource name pattern(s) for this resource type.

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>

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

Clone()

Declaration
public ResourceDescriptor Clone()
Returns
Type Description
ResourceDescriptor
Implements

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

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

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

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements