Struct Workstation 

#[non_exhaustive]
pub struct Workstation {

    pub name: String,
    pub display_name: String,
    pub uid: String,
    pub reconciling: bool,
    pub annotations: HashMap<String, String>,
    pub labels: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub start_time: Option<Timestamp>,
    pub delete_time: Option<Timestamp>,
    pub etag: String,
    pub persistent_directories: Vec<WorkstationPersistentDirectory>,
    pub state: State,
    pub host: String,
    pub env: HashMap<String, String>,
    pub kms_key: String,
    pub source_workstation: String,
    pub runtime_host: Option<RuntimeHost>,
    /* private fields */
}

A single instance of a developer workstation with its own persistent storage.

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. Full name of this workstation.

display_name: String

Optional. Human-readable name for this workstation.

uid: String

Output only. A system-assigned unique identifier for this workstation.

reconciling: bool

Output only. Indicates whether this workstation is currently being updated to match its intended state.

annotations: HashMap<String, String>

Optional. Client-specified annotations.

labels: HashMap<String, String>

Optional. Labels that are applied to the workstation and that are also propagated to the underlying Compute Engine resources.

create_time: Option<Timestamp>

Output only. Time when this workstation was created.

update_time: Option<Timestamp>

Output only. Time when this workstation was most recently updated.

start_time: Option<Timestamp>

Output only. Time when this workstation was most recently successfully started, regardless of the workstation’s initial state.

delete_time: Option<Timestamp>

Output only. Time when this workstation was soft-deleted.

etag: String

Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding.

persistent_directories: Vec<WorkstationPersistentDirectory>

Optional. Directories to persist across workstation sessions.

state: State

Output only. Current state of the workstation.

host: String

Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format {port}-{host}.

env: HashMap<String, String>

Optional. Environment variables passed to the workstation container’s entrypoint.

kms_key: String

Output only. The name of the Google Cloud KMS encryption key used to encrypt this workstation. The KMS key can only be configured in the WorkstationConfig. The expected format is projects/*/locations/*/keyRings/*/cryptoKeys/*.

source_workstation: String

Optional. The source workstation from which this workstation’s persistent directories were cloned on creation.

runtime_host: Option<RuntimeHost>

Optional. Output only. Runtime host for the workstation when in STATE_RUNNING.

Implementations

impl Workstation

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 = Workstation::new().set_name(format!("projects/{project_id}/locations/{location_id}/workstationClusters/{workstation_cluster_id}/workstationConfigs/{workstation_config_id}/workstations/{workstation_id}"));

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

Sets the value of display_name.

Example

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

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

Sets the value of uid.

Example

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

pub fn set_reconciling<T: Into<bool>>(self, v: T) -> Self

Sets the value of reconciling.

Example

let x = Workstation::new().set_reconciling(true);

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 = Workstation::new().set_annotations([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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 = Workstation::new().set_labels([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

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

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

where T: Into<Timestamp>,

Sets the value of start_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of start_time.

Example

use wkt::Timestamp;
let x = Workstation::new().set_or_clear_start_time(Some(Timestamp::default()/* use setters */));
let x = Workstation::new().set_or_clear_start_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 = Workstation::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 = Workstation::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = Workstation::new().set_or_clear_delete_time(None::<Timestamp>);

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

Sets the value of etag.

Example

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

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

where T: IntoIterator<Item = V>, V: Into<WorkstationPersistentDirectory>,

Sets the value of persistent_directories.

Example

use google_cloud_workstations_v1::model::workstation::WorkstationPersistentDirectory;
let x = Workstation::new()
    .set_persistent_directories([
        WorkstationPersistentDirectory::default()/* use setters */,
        WorkstationPersistentDirectory::default()/* use (different) setters */,
    ]);

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

Sets the value of state.

Example

use google_cloud_workstations_v1::model::workstation::State;
let x0 = Workstation::new().set_state(State::Starting);
let x1 = Workstation::new().set_state(State::Running);
let x2 = Workstation::new().set_state(State::Stopping);

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

Sets the value of host.

Example

let x = Workstation::new().set_host("example");

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

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

Sets the value of env.

Example

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

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

Sets the value of kms_key.

Example

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

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

Sets the value of source_workstation.

Example

let x = Workstation::new().set_source_workstation("example");

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

where T: Into<RuntimeHost>,

Sets the value of runtime_host.

Example

use google_cloud_workstations_v1::model::workstation::RuntimeHost;
let x = Workstation::new().set_runtime_host(RuntimeHost::default()/* use setters */);

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

where T: Into<RuntimeHost>,

Sets or clears the value of runtime_host.

Example

use google_cloud_workstations_v1::model::workstation::RuntimeHost;
let x = Workstation::new().set_or_clear_runtime_host(Some(RuntimeHost::default()/* use setters */));
let x = Workstation::new().set_or_clear_runtime_host(None::<RuntimeHost>);

Trait Implementations

impl Clone for Workstation

fn clone(&self) -> Workstation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workstation

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

Formats the value using the given formatter.

impl Default for Workstation

fn default() -> Workstation

Returns the “default value” for a type.

impl Message for Workstation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Workstation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Workstation