public interface ResourceDescriptorOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getHistory()
public abstract 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;
| Type | Description |
ResourceDescriptor.History | The history. |
getHistoryValue()
public abstract 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;
| Type | Description |
int | The enum numeric value on the wire for history. |
getNameField()
public abstract 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;
| Type | Description |
String | The nameField. |
getNameFieldBytes()
public abstract 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;
| Type | Description |
ByteString | The bytes for nameField. |
getPattern(int index)
public abstract 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;
| Name | Description |
index | intThe index of the element to return. |
| Type | Description |
String | The pattern at the given index. |
getPatternBytes(int index)
public abstract 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;
| Name | Description |
index | intThe index of the value to return. |
| Type | Description |
ByteString | The bytes of the pattern at the given index. |
getPatternCount()
public abstract 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;
| Type | Description |
int | The count of pattern. |
getPatternList()
public abstract List<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;
| Type | Description |
List<String> | A list containing the pattern. |
getPlural()
public abstract String getPlural() The plural name used in the resource name and permission names, such as
'projects' for the resource name of 'projects/{project}' and the permission
name of 'cloudresourcemanager.googleapis.com/projects.get'. 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/
Note: The plural form is required even for singleton resources. See
https://aip.dev/156
string plural = 5;
| Type | Description |
String | The plural. |
getPluralBytes()
public abstract ByteString getPluralBytes() The plural name used in the resource name and permission names, such as
'projects' for the resource name of 'projects/{project}' and the permission
name of 'cloudresourcemanager.googleapis.com/projects.get'. 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/
Note: The plural form is required even for singleton resources. See
https://aip.dev/156
string plural = 5;
| Type | Description |
ByteString | The bytes for plural. |
getSingular()
public abstract 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;
| Type | Description |
String | The singular. |
getSingularBytes()
public abstract 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;
| Type | Description |
ByteString | The bytes for singular. |
getStyle(int index)
public abstract ResourceDescriptor.Style getStyle(int index)Style flag(s) for this resource. These indicate that a resource is expected to conform to a given style. See the specific style flags for additional information.
repeated .google.api.ResourceDescriptor.Style style = 10;
| Name | Description |
index | intThe index of the element to return. |
| Type | Description |
ResourceDescriptor.Style | The style at the given index. |
getStyleCount()
public abstract int getStyleCount()Style flag(s) for this resource. These indicate that a resource is expected to conform to a given style. See the specific style flags for additional information.
repeated .google.api.ResourceDescriptor.Style style = 10;
| Type | Description |
int | The count of style. |
getStyleList()
public abstract List<ResourceDescriptor.Style> getStyleList()Style flag(s) for this resource. These indicate that a resource is expected to conform to a given style. See the specific style flags for additional information.
repeated .google.api.ResourceDescriptor.Style style = 10;
| Type | Description |
List<Style> | A list containing the style. |
getStyleValue(int index)
public abstract int getStyleValue(int index)Style flag(s) for this resource. These indicate that a resource is expected to conform to a given style. See the specific style flags for additional information.
repeated .google.api.ResourceDescriptor.Style style = 10;
| Name | Description |
index | intThe index of the value to return. |
| Type | Description |
int | The enum numeric value on the wire of style at the given index. |
getStyleValueList()
public abstract List<Integer> getStyleValueList()Style flag(s) for this resource. These indicate that a resource is expected to conform to a given style. See the specific style flags for additional information.
repeated .google.api.ResourceDescriptor.Style style = 10;
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for style. |
getType()
public abstract 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+/. 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;
| Type | Description |
String | The type. |
getTypeBytes()
public abstract 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+/. 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;
| Type | Description |
ByteString | The bytes for type. |