com.google.api

Interface ResourceDescriptorOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

ResourceDescriptor, ResourceDescriptor.Builder

public interface ResourceDescriptorOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ResourceDescriptor.History	getHistory() Optional.
int	getHistoryValue() Optional.
java.lang.String	getNameField() Optional.
ByteString	getNameFieldBytes() Optional.
java.lang.String	getPattern(int index) Optional.
ByteString	getPatternBytes(int index) Optional.
int	getPatternCount() Optional.
java.util.List<java.lang.String>	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}'.
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.

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

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;

getTypeBytes

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;

getPatternList

java.util.List<java.lang.String> 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;

getPatternCount

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;

getPattern

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;

getPatternBytes

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;

getNameField

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;

getNameFieldBytes

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;

getPlural

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;

getPluralBytes

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;

getSingular

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;

getSingularBytes

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;