com.google.api

Class ResourceDescriptor

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.ResourceDescriptor

All Implemented Interfaces:

ResourceDescriptorOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class ResourceDescriptor
extends GeneratedMessageV3
implements ResourceDescriptorOrBuilder

 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"
 

Protobuf type google.api.ResourceDescriptor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceDescriptor.Builder A simple descriptor of a resource type.
static class	ResourceDescriptor.History A description of the historical or future-looking state of the resource pattern.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	HISTORY_FIELD_NUMBER
static int	NAME_FIELD_FIELD_NUMBER
static int	PATTERN_FIELD_NUMBER
static int	PLURAL_FIELD_NUMBER
static int	SINGULAR_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ResourceDescriptor	getDefaultInstance()
ResourceDescriptor	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
ResourceDescriptor.History	getHistory() Optional.
int	getHistoryValue() Optional.
java.lang.String	getNameField() Optional.
ByteString	getNameFieldBytes() Optional.
Parser<ResourceDescriptor>	getParserForType()
java.lang.String	getPattern(int index) Optional.
ByteString	getPatternBytes(int index) Optional.
int	getPatternCount() Optional.
ProtocolStringList	getPatternList() Optional.
java.lang.String	getPlural() The plural name used in the resource name, such as 'projects' for the name of 'projects/{project}'.
ByteString	getPluralBytes() The plural name used in the resource name, such as 'projects' for the name of 'projects/{project}'.
int	getSerializedSize()
java.lang.String	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.
ByteString	getSingularBytes() 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.
java.lang.String	getType() The resource type.
ByteString	getTypeBytes() The resource type.
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResourceDescriptor.Builder	newBuilder()
static ResourceDescriptor.Builder	newBuilder(ResourceDescriptor prototype)
ResourceDescriptor.Builder	newBuilderForType()
protected ResourceDescriptor.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static ResourceDescriptor	parseDelimitedFrom(java.io.InputStream input)
static ResourceDescriptor	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(byte[] data)
static ResourceDescriptor	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(java.nio.ByteBuffer data)
static ResourceDescriptor	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(ByteString data)
static ResourceDescriptor	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(CodedInputStream input)
static ResourceDescriptor	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(java.io.InputStream input)
static ResourceDescriptor	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ResourceDescriptor>	parser()
ResourceDescriptor.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

PATTERN_FIELD_NUMBER

public static final int PATTERN_FIELD_NUMBER

See Also:

Constant Field Values

NAME_FIELD_FIELD_NUMBER

public static final int NAME_FIELD_FIELD_NUMBER

See Also:

Constant Field Values

HISTORY_FIELD_NUMBER

public static final int HISTORY_FIELD_NUMBER

See Also:

Constant Field Values

PLURAL_FIELD_NUMBER

public static final int PLURAL_FIELD_NUMBER

See Also:

Constant Field Values

SINGULAR_FIELD_NUMBER

public static final int SINGULAR_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getType

public java.lang.String 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.
 

string type = 1;

Specified by:

getType in interface ResourceDescriptorOrBuilder

getTypeBytes

public ByteString getTypeBytes()

 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.
 

string type = 1;

Specified by:

getTypeBytes in interface ResourceDescriptorOrBuilder

getPatternList

public ProtocolStringList getPatternList()

 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.
 

repeated string pattern = 2;

Specified by:

getPatternList in interface ResourceDescriptorOrBuilder

getPatternCount

public int getPatternCount()

 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.
 

repeated string pattern = 2;

Specified by:

getPatternCount in interface ResourceDescriptorOrBuilder

getPattern

public java.lang.String getPattern(int index)

 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.
 

repeated string pattern = 2;

Specified by:

getPattern in interface ResourceDescriptorOrBuilder

getPatternBytes

public ByteString getPatternBytes(int index)

 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.
 

repeated string pattern = 2;

Specified by:

getPatternBytes in interface ResourceDescriptorOrBuilder

getNameField

public java.lang.String getNameField()

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

string name_field = 3;

Specified by:

getNameField in interface ResourceDescriptorOrBuilder

getNameFieldBytes

public ByteString getNameFieldBytes()

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

string name_field = 3;

Specified by:

getNameFieldBytes in interface ResourceDescriptorOrBuilder

getHistoryValue

public int getHistoryValue()

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

.google.api.ResourceDescriptor.History history = 4;

Specified by:

getHistoryValue in interface ResourceDescriptorOrBuilder

getHistory

public ResourceDescriptor.History 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
       };
     }
 

.google.api.ResourceDescriptor.History history = 4;

Specified by:

getHistory in interface ResourceDescriptorOrBuilder

getPlural

public java.lang.String 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/
 

string plural = 5;

Specified by:

getPlural in interface ResourceDescriptorOrBuilder

getPluralBytes

public ByteString getPluralBytes()

 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/
 

string plural = 5;

Specified by:

getPluralBytes in interface ResourceDescriptorOrBuilder

getSingular

public java.lang.String 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.
 

string singular = 6;

Specified by:

getSingular in interface ResourceDescriptorOrBuilder

getSingularBytes

public ByteString getSingularBytes()

 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.
 

string singular = 6;

Specified by:

getSingularBytes in interface ResourceDescriptorOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ResourceDescriptor parseFrom(java.nio.ByteBuffer data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(java.nio.ByteBuffer data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(ByteString data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(ByteString data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(byte[] data)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(byte[] data,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(java.io.InputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ResourceDescriptor parseFrom(java.io.InputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ResourceDescriptor parseDelimitedFrom(java.io.InputStream input)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static ResourceDescriptor parseDelimitedFrom(java.io.InputStream input,
                                                    ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ResourceDescriptor parseFrom(CodedInputStream input)
                                    throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static ResourceDescriptor parseFrom(CodedInputStream input,
                                           ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public ResourceDescriptor.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ResourceDescriptor.Builder newBuilder()

newBuilder

public static ResourceDescriptor.Builder newBuilder(ResourceDescriptor prototype)

toBuilder

public ResourceDescriptor.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ResourceDescriptor.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ResourceDescriptor getDefaultInstance()

parser

public static Parser<ResourceDescriptor> parser()

getParserForType

public Parser<ResourceDescriptor> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ResourceDescriptor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder