Class ResourceDescriptor (2.10.0)

Version latest

• 2.10.0 (latest)
• 2.2.0

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

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

The ResourceDescriptor Yaml config will look like:

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

The ResourceDescriptor Yaml config will look like:

resources:
- type: 'logging.googleapis.com/LogEntry'
  pattern: "projects/{project}/logs/{log}"
  pattern: "folders/{folder}/logs/{log}"
  pattern: "organizations/{organization}/logs/{log}"
  pattern: "billingAccounts/{billing_account}/logs/{log}"

Inheritance

object > ResourceDescriptor

Implements

IMessageResourceDescriptor, IEquatableResourceDescriptor, IDeepCloneableResourceDescriptor, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

ResourceDescriptor()

public ResourceDescriptor()

ResourceDescriptor(ResourceDescriptor)

public ResourceDescriptor(ResourceDescriptor other)

Parameter
Name	Description
other	ResourceDescriptor

Fields

HistoryFieldNumber

public const int HistoryFieldNumber = 4

Field number for the "history" field.

Field Value
Type	Description
int

NameFieldFieldNumber

public const int NameFieldFieldNumber = 3

Field number for the "name_field" field.

Field Value
Type	Description
int

PatternFieldNumber

public const int PatternFieldNumber = 2

Field number for the "pattern" field.

Field Value
Type	Description
int

PluralFieldNumber

public const int PluralFieldNumber = 5

Field number for the "plural" field.

Field Value
Type	Description
int

SingularFieldNumber

public const int SingularFieldNumber = 6

Field number for the "singular" field.

Field Value
Type	Description
int

StyleFieldNumber

public const int StyleFieldNumber = 10

Field number for the "style" field.

Field Value
Type	Description
int

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
Type	Description
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
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
Type	Description
ResourceDescriptorTypesHistory

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
Type	Description
string

Parser

public static MessageParser<ResourceDescriptor> Parser { get; }

Property Value
Type	Description
MessageParserResourceDescriptor

Pattern

public 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
Type	Description
RepeatedFieldstring

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
Type	Description
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
Type	Description
string

Style

public 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
Type	Description
RepeatedFieldResourceDescriptorTypesStyle

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
Type	Description
string

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
int

Clone()

public ResourceDescriptor Clone()

Returns
Type	Description
ResourceDescriptor

Equals(ResourceDescriptor)

public bool Equals(ResourceDescriptor other)

Parameter
Name	Description
other	ResourceDescriptor

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(ResourceDescriptor)

public void MergeFrom(ResourceDescriptor other)

Parameter
Name	Description
other	ResourceDescriptor

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream