Struct Instance 

#[non_exhaustive]
pub struct Instance {
    pub name: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: HashMap<String, String>,
    pub private_config: Option<PrivateConfig>,
    pub state: State,
    pub state_note: StateNote,
    pub kms_key: String,
    pub host_config: Option<HostConfig>,
    pub workforce_identity_federation_config: Option<WorkforceIdentityFederationConfig>,
    /* private fields */
}

A resource that represents a Secure Source Manager instance.

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

Identifier. A unique identifier for an instance. The name should be of the format: projects/{project_number}/locations/{location_id}/instances/{instance_id}

project_number: Maps to a unique int64 id assigned to each project.

location_id: Refers to the region where the instance will be deployed. Since Secure Source Manager is a regional service, it must be one of the valid GCP regions.

instance_id: User provided name for the instance, must be unique for a project_number and location_id combination.

create_time: Option<Timestamp>

Output only. Create timestamp.

update_time: Option<Timestamp>

Output only. Update timestamp.

labels: HashMap<String, String>

Optional. Labels as key value pairs. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. For more information, see Requirements for labels.

private_config: Option<PrivateConfig>

Optional. Private settings for private instance.

state: State

Output only. Current state of the instance.

state_note: StateNote

Output only. An optional field providing information about the current instance state.

kms_key: String

Optional. Immutable. Customer-managed encryption key name, in the format projects//locations//keyRings//cryptoKeys/.

host_config: Option<HostConfig>

Output only. A list of hostnames for this instance.

workforce_identity_federation_config: Option<WorkforceIdentityFederationConfig>

Optional. Configuration for Workforce Identity Federation to support third party identity provider. If unset, defaults to the Google OIDC IdP.

Implementations

impl Instance

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Instance::new().set_name(format!("projects/{project_id}/locations/{location_id}/instances/{instance_id}"));

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 = Instance::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 = Instance::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Instance::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 = Instance::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 = Instance::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = Instance::new().set_or_clear_update_time(None::<Timestamp>);

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

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

Sets the value of labels.

Example

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

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

where T: Into<PrivateConfig>,

Sets the value of private_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::PrivateConfig;
let x = Instance::new().set_private_config(PrivateConfig::default()/* use setters */);

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

where T: Into<PrivateConfig>,

Sets or clears the value of private_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::PrivateConfig;
let x = Instance::new().set_or_clear_private_config(Some(PrivateConfig::default()/* use setters */));
let x = Instance::new().set_or_clear_private_config(None::<PrivateConfig>);

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_securesourcemanager_v1::model::instance::State;
let x0 = Instance::new().set_state(State::Creating);
let x1 = Instance::new().set_state(State::Active);
let x2 = Instance::new().set_state(State::Deleting);

pub fn set_state_note<T: Into<StateNote>>(self, v: T) -> Self

Sets the value of state_note.

Example

use google_cloud_securesourcemanager_v1::model::instance::StateNote;
let x0 = Instance::new().set_state_note(StateNote::PausedCmekUnavailable);

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

Sets the value of kms_key.

Example

let x = Instance::new().set_kms_key("example");

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

where T: Into<HostConfig>,

Sets the value of host_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::HostConfig;
let x = Instance::new().set_host_config(HostConfig::default()/* use setters */);

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

where T: Into<HostConfig>,

Sets or clears the value of host_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::HostConfig;
let x = Instance::new().set_or_clear_host_config(Some(HostConfig::default()/* use setters */));
let x = Instance::new().set_or_clear_host_config(None::<HostConfig>);

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

where T: Into<WorkforceIdentityFederationConfig>,

Sets the value of workforce_identity_federation_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::WorkforceIdentityFederationConfig;
let x = Instance::new().set_workforce_identity_federation_config(WorkforceIdentityFederationConfig::default()/* use setters */);

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

where T: Into<WorkforceIdentityFederationConfig>,

Sets or clears the value of workforce_identity_federation_config.

Example

use google_cloud_securesourcemanager_v1::model::instance::WorkforceIdentityFederationConfig;
let x = Instance::new().set_or_clear_workforce_identity_federation_config(Some(WorkforceIdentityFederationConfig::default()/* use setters */));
let x = Instance::new().set_or_clear_workforce_identity_federation_config(None::<WorkforceIdentityFederationConfig>);

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instance

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

Formats the value using the given formatter.

impl Default for Instance

fn default() -> Instance

Returns the “default value” for a type.

impl Message for Instance

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Instance

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Instance