com.google.api

Interface ResourceDescriptorOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ResourceDescriptor, ResourceDescriptor.Builder

public interface ResourceDescriptorOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
List<String>	getPatternList() Required.
String	getType() The full name of the resource type.
com.google.protobuf.ByteString	getTypeBytes() The full name of the resource type.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getType

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;

getTypeBytes

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;

getPatternList

List<String> 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;

getPatternCount

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;

getPattern

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;

getPatternBytes

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;

getNameField

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;

getNameFieldBytes

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;

getHistoryValue

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;

getHistory

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;