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, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ResourceDescriptor
extends com.google.protobuf.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"
       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}"
     };
   }
 

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.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	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(Object obj)
static ResourceDescriptor	getDefaultInstance()
ResourceDescriptor	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
ResourceDescriptor.History	getHistory() Optional.
int	getHistoryValue() Optional.
String	getNameField() Optional.
com.google.protobuf.ByteString	getNameFieldBytes() Optional.
com.google.protobuf.Parser<ResourceDescriptor>	getParserForType()
String	getPattern(int index) Required.
com.google.protobuf.ByteString	getPatternBytes(int index) Required.
int	getPatternCount() Required.
com.google.protobuf.ProtocolStringList	getPatternList() Required.
int	getSerializedSize()
String	getType() The full name of the resource type.
com.google.protobuf.ByteString	getTypeBytes() The full name of the resource type.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ResourceDescriptor.Builder	newBuilder()
static ResourceDescriptor.Builder	newBuilder(ResourceDescriptor prototype)
ResourceDescriptor.Builder	newBuilderForType()
protected ResourceDescriptor.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static ResourceDescriptor	parseDelimitedFrom(InputStream input)
static ResourceDescriptor	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(byte[] data)
static ResourceDescriptor	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(ByteBuffer data)
static ResourceDescriptor	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(com.google.protobuf.ByteString data)
static ResourceDescriptor	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(com.google.protobuf.CodedInputStream input)
static ResourceDescriptor	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ResourceDescriptor	parseFrom(InputStream input)
static ResourceDescriptor	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ResourceDescriptor>	parser()
ResourceDescriptor.Builder	toBuilder()
void	writeTo(com.google.protobuf.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

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getType

public String getType()

 The full name of the resource type. It must be in the format of
 {service_name}/{resource_type_kind}. The resource type names are
 singular and do not contain version numbers.
 For example: `storage.googleapis.com/Bucket`
 The value of the resource_type_kind must follow the regular expression
 /[A-Z][a-zA-Z0-9]+/. It must start with upper case character and
 recommended to 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 com.google.protobuf.ByteString getTypeBytes()

 The full name of the resource type. It must be in the format of
 {service_name}/{resource_type_kind}. The resource type names are
 singular and do not contain version numbers.
 For example: `storage.googleapis.com/Bucket`
 The value of the resource_type_kind must follow the regular expression
 /[A-Z][a-zA-Z0-9]+/. It must start with upper case character and
 recommended to 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 com.google.protobuf.ProtocolStringList getPatternList()

 Required. The valid pattern or patterns for this resource's names.
 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()

 Required. The valid pattern or patterns for this resource's names.
 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 String getPattern(int index)

 Required. The valid pattern or patterns for this resource's names.
 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 com.google.protobuf.ByteString getPatternBytes(int index)

 Required. The valid pattern or patterns for this resource's names.
 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 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 com.google.protobuf.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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ResourceDescriptor parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ResourceDescriptor parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ResourceDescriptor parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static ResourceDescriptor parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static ResourceDescriptor parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static ResourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static ResourceDescriptor parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public ResourceDescriptor.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ResourceDescriptor.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ResourceDescriptor getDefaultInstance()

parser

public static com.google.protobuf.Parser<ResourceDescriptor> parser()

getParserForType

public com.google.protobuf.Parser<ResourceDescriptor> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ResourceDescriptor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder