Struct Key 

#[non_exhaustive]
pub struct Key {
    pub name: String,
    pub uid: String,
    pub display_name: String,
    pub key_string: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub annotations: HashMap<String, String>,
    pub restrictions: Option<Restrictions>,
    pub etag: String,
    /* private fields */
}

The representation of a key managed by the API Keys API.

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

Output only. The resource name of the key. The name has the form: projects/<PROJECT_NUMBER>/locations/global/keys/<KEY_ID>. For example: projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2

NOTE: Key is a global resource; hence the only supported value for location is global.

uid: String

Output only. Unique id in UUID4 format.

display_name: String

Human-readable display name of this key that you can modify. The maximum length is 63 characters.

key_string: String

Output only. An encrypted and signed value held by this key. This field can be accessed only through the GetKeyString method.

create_time: Option<Timestamp>

Output only. A timestamp identifying the time this key was originally created.

update_time: Option<Timestamp>

Output only. A timestamp identifying the time this key was last updated.

delete_time: Option<Timestamp>

Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty.

annotations: HashMap<String, String>

Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

restrictions: Option<Restrictions>

Key restrictions.

etag: String

Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154.

Implementations

impl Key

pub fn new() -> Self

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

Sets the value of name.

Example

let x = Key::new().set_name("example");

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

Sets the value of uid.

Example

let x = Key::new().set_uid("example");

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

Sets the value of display_name.

Example

let x = Key::new().set_display_name("example");

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

Sets the value of key_string.

Example

let x = Key::new().set_key_string("example");

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Key::new().set_create_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_create_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Key::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Key::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of update_time.

Example

use wkt::Timestamp;
let x = Key::new().set_update_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_update_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of update_time.

Example

use wkt::Timestamp;
let x = Key::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Key::new().set_or_clear_update_time(None::<Timestamp>);

pub fn set_delete_time<T>(self, v: T) -> Self

where T: Into<Timestamp>,

Sets the value of delete_time.

Example

use wkt::Timestamp;
let x = Key::new().set_delete_time(Timestamp::default()/* use setters */);

pub fn set_or_clear_delete_time<T>(self, v: Option<T>) -> Self

where T: Into<Timestamp>,

Sets or clears the value of delete_time.

Example

use wkt::Timestamp;
let x = Key::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = Key::new().set_or_clear_delete_time(None::<Timestamp>);

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

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

Sets the value of annotations.

Example

let x = Key::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

pub fn set_restrictions<T>(self, v: T) -> Self

where T: Into<Restrictions>,

Sets the value of restrictions.

Example

use google_cloud_apikeys_v2::model::Restrictions;
let x = Key::new().set_restrictions(Restrictions::default()/* use setters */);

pub fn set_or_clear_restrictions<T>(self, v: Option<T>) -> Self

where T: Into<Restrictions>,

Sets or clears the value of restrictions.

Example

use google_cloud_apikeys_v2::model::Restrictions;
let x = Key::new().set_or_clear_restrictions(Some(Restrictions::default()/* use setters */));
let x = Key::new().set_or_clear_restrictions(None::<Restrictions>);

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

Sets the value of etag.

Example

let x = Key::new().set_etag("example");

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Message for Key

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Key

fn eq(&self, other: &Key) -> 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 StructuralPartialEq for Key