Struct googapis::google::api::ResourceDescriptor [−][src]
pub struct ResourceDescriptor {
pub type: String,
pub pattern: Vec<String>,
pub name_field: String,
pub history: i32,
pub plural: String,
pub singular: String,
pub style: Vec<i32>,
}
Expand description
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"
name_descriptor: {
pattern: "projects/{project}/topics/{topic}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
parent_name_extractor: "projects/{project}"
}
};
}
The ResourceDescriptor Yaml config will look like:
resources:
- type: "pubsub.googleapis.com/Topic"
name_descriptor:
- pattern: "projects/{project}/topics/{topic}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
parent_name_extractor: "projects/{project}"
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"
name_descriptor: {
pattern: "projects/{project}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
parent_name_extractor: "projects/{project}"
}
name_descriptor: {
pattern: "folders/{folder}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Folder"
parent_name_extractor: "folders/{folder}"
}
name_descriptor: {
pattern: "organizations/{organization}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Organization"
parent_name_extractor: "organizations/{organization}"
}
name_descriptor: {
pattern: "billingAccounts/{billing_account}/logs/{log}"
parent_type: "billing.googleapis.com/BillingAccount"
parent_name_extractor: "billingAccounts/{billing_account}"
}
};
}
The ResourceDescriptor Yaml config will look like:
resources:
- type: 'logging.googleapis.com/LogEntry'
name_descriptor:
- pattern: "projects/{project}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
parent_name_extractor: "projects/{project}"
- pattern: "folders/{folder}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Folder"
parent_name_extractor: "folders/{folder}"
- pattern: "organizations/{organization}/logs/{log}"
parent_type: "cloudresourcemanager.googleapis.com/Organization"
parent_name_extractor: "organizations/{organization}"
- pattern: "billingAccounts/{billing_account}/logs/{log}"
parent_type: "billing.googleapis.com/BillingAccount"
parent_name_extractor: "billingAccounts/{billing_account}"
For flexible resources, the resource name doesn’t contain parent names, but the resource itself has parents for policy evaluation.
Example:
message Shelf {
option (google.api.resource) = {
type: "library.googleapis.com/Shelf"
name_descriptor: {
pattern: "shelves/{shelf}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
}
name_descriptor: {
pattern: "shelves/{shelf}"
parent_type: "cloudresourcemanager.googleapis.com/Folder"
}
};
}
The ResourceDescriptor Yaml config will look like:
resources:
- type: 'library.googleapis.com/Shelf'
name_descriptor:
- pattern: "shelves/{shelf}"
parent_type: "cloudresourcemanager.googleapis.com/Project"
- pattern: "shelves/{shelf}"
parent_type: "cloudresourcemanager.googleapis.com/Folder"
Fields
type: String
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.
pattern: Vec<String>
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.
name_field: String
Optional. The field on the resource that designates the resource name field. If omitted, this is assumed to be “name”.
history: i32
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
};
}
plural: String
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
singular: String
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.
style: Vec<i32>
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.
Implementations
Returns the enum value of history
, or the default if the field is set to an invalid enum value.
Sets history
to the provided enum value.
Returns an iterator which yields the valid enum values contained in style
.
Appends the provided enum value to style
.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
Decodes a length-delimited instance of the message from the buffer.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for ResourceDescriptor
impl Send for ResourceDescriptor
impl Sync for ResourceDescriptor
impl Unpin for ResourceDescriptor
impl UnwindSafe for ResourceDescriptor
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more