Struct TagKey

#[non_exhaustive]
pub struct TagKey {
    pub name: String,
    pub parent: String,
    pub short_name: String,
    pub namespaced_name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub etag: String,
    pub purpose: Purpose,
    pub purpose_data: HashMap<String, String>,
}

A TagKey, used to group a set of TagValues.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Immutable. The resource name for a TagKey. Must be in the format tagKeys/{tag_key_id}, where tag_key_id is the generated numeric id for the TagKey.

parent: String

Immutable. The resource name of the TagKey’s parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form organizations/{org_id}. For a TagKey parented by a Project, its parent can be in the form projects/{project_id} or projects/{project_number}.

short_name: String

Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace.

The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between.

namespaced_name: String

Output only. Immutable. Namespaced name of the TagKey.

description: String

Optional. User-assigned description of the TagKey. Must not exceed 256 characters.

Read-write.

create_time: Option<Timestamp>

Output only. Creation time.

update_time: Option<Timestamp>

Output only. Update time.

etag: String

Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details.

purpose: Purpose

Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines.

A purpose cannot be changed once set.

purpose_data: HashMap<String, String>

Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for Purpose for formatting of this field.

Purpose data cannot be changed once set.

Implementations

impl TagKey

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

pub fn set_short_name<T: Into<String>>(self, v: T) -> Self

Sets the value of short_name.

pub fn set_namespaced_name<T: Into<String>>(self, v: T) -> Self

Sets the value of namespaced_name.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

pub fn set_etag<T: Into<String>>(self, v: T) -> Self

Sets the value of etag.

pub fn set_purpose<T: Into<Purpose>>(self, v: T) -> Self

Sets the value of purpose.

pub fn set_purpose_data<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of purpose_data.

Trait Implementations

impl Clone for TagKey

fn clone(&self) -> TagKey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TagKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TagKey

fn default() -> TagKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TagKey

where TagKey: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for TagKey

fn typename() -> &'static str

The typename of this message.

impl PartialEq for TagKey

fn eq(&self, other: &TagKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TagKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TagKey