com.google.api

Class ResourceDescriptor.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

com.google.api.ResourceDescriptor.Builder

All Implemented Interfaces:

ResourceDescriptorOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ResourceDescriptor

public static final class ResourceDescriptor.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>
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

Method Summary

Modifier and Type	Method and Description
ResourceDescriptor.Builder	addAllPattern(Iterable<String> values) Required.
ResourceDescriptor.Builder	addPattern(String value) Required.
ResourceDescriptor.Builder	addPatternBytes(com.google.protobuf.ByteString value) Required.
ResourceDescriptor.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ResourceDescriptor	build()
ResourceDescriptor	buildPartial()
ResourceDescriptor.Builder	clear()
ResourceDescriptor.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ResourceDescriptor.Builder	clearHistory() Optional.
ResourceDescriptor.Builder	clearNameField() Optional.
ResourceDescriptor.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ResourceDescriptor.Builder	clearPattern() Required.
ResourceDescriptor.Builder	clearType() The full name of the resource type.
ResourceDescriptor.Builder	clone()
ResourceDescriptor	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
ResourceDescriptor.History	getHistory() Optional.
int	getHistoryValue() Optional.
String	getNameField() Optional.
com.google.protobuf.ByteString	getNameFieldBytes() Optional.
String	getPattern(int index) Required.
com.google.protobuf.ByteString	getPatternBytes(int index) Required.
int	getPatternCount() Required.
com.google.protobuf.ProtocolStringList	getPatternList() Required.
String	getType() The full name of the resource type.
com.google.protobuf.ByteString	getTypeBytes() The full name of the resource type.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ResourceDescriptor.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ResourceDescriptor.Builder	mergeFrom(com.google.protobuf.Message other)
ResourceDescriptor.Builder	mergeFrom(ResourceDescriptor other)
ResourceDescriptor.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ResourceDescriptor.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ResourceDescriptor.Builder	setHistory(ResourceDescriptor.History value) Optional.
ResourceDescriptor.Builder	setHistoryValue(int value) Optional.
ResourceDescriptor.Builder	setNameField(String value) Optional.
ResourceDescriptor.Builder	setNameFieldBytes(com.google.protobuf.ByteString value) Optional.
ResourceDescriptor.Builder	setPattern(int index, String value) Required.
ResourceDescriptor.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ResourceDescriptor.Builder	setType(String value) The full name of the resource type.
ResourceDescriptor.Builder	setTypeBytes(com.google.protobuf.ByteString value) The full name of the resource type.
ResourceDescriptor.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<ResourceDescriptor.Builder>

clear

public ResourceDescriptor.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

getDefaultInstanceForType

public ResourceDescriptor getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ResourceDescriptor build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ResourceDescriptor buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ResourceDescriptor.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

setField

public ResourceDescriptor.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

clearField

public ResourceDescriptor.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

clearOneof

public ResourceDescriptor.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

setRepeatedField

public ResourceDescriptor.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

addRepeatedField

public ResourceDescriptor.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

mergeFrom

public ResourceDescriptor.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourceDescriptor.Builder>

mergeFrom

public ResourceDescriptor.Builder mergeFrom(ResourceDescriptor other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

mergeFrom

public ResourceDescriptor.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ResourceDescriptor.Builder>

Throws:

IOException

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

setType

public ResourceDescriptor.Builder setType(String value)

 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;

clearType

public ResourceDescriptor.Builder clearType()

 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;

setTypeBytes

public ResourceDescriptor.Builder setTypeBytes(com.google.protobuf.ByteString value)

 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;

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

setPattern

public ResourceDescriptor.Builder setPattern(int index,
                                             String value)

 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;

addPattern

public ResourceDescriptor.Builder addPattern(String value)

 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;

addAllPattern

public ResourceDescriptor.Builder addAllPattern(Iterable<String> values)

 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;

clearPattern

public ResourceDescriptor.Builder clearPattern()

 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;

addPatternBytes

public ResourceDescriptor.Builder addPatternBytes(com.google.protobuf.ByteString value)

 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;

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

setNameField

public ResourceDescriptor.Builder setNameField(String value)

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

string name_field = 3;

clearNameField

public ResourceDescriptor.Builder clearNameField()

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

string name_field = 3;

setNameFieldBytes

public ResourceDescriptor.Builder setNameFieldBytes(com.google.protobuf.ByteString value)

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

string name_field = 3;

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

setHistoryValue

public ResourceDescriptor.Builder setHistoryValue(int value)

 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;

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

setHistory

public ResourceDescriptor.Builder setHistory(ResourceDescriptor.History value)

 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;

clearHistory

public ResourceDescriptor.Builder clearHistory()

 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;

setUnknownFields

public final ResourceDescriptor.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>

mergeUnknownFields

public final ResourceDescriptor.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ResourceDescriptor.Builder>