Struct WorkstationCluster 

#[non_exhaustive]
pub struct WorkstationCluster {

    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 delete_time: Option<Timestamp>,
    pub etag: String,
    pub network: String,
    pub subnetwork: String,
    pub control_plane_ip: String,
    pub private_cluster_config: Option<PrivateClusterConfig>,
    pub domain_config: Option<DomainConfig>,
    pub degraded: bool,
    pub conditions: Vec<Status>,
    pub tags: HashMap<String, String>,
    pub gateway_config: Option<GatewayConfig>,
    pub workstation_authorization_url: String,
    pub workstation_launch_url: String,
    /* private fields */
}

A workstation cluster resource in the Cloud Workstations API.

Defines a group of workstations in a particular region and the VPC network they’re attached to.

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 cluster.

display_name: String

Optional. Human-readable name for this workstation cluster.

uid: String

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

reconciling: bool

Output only. Indicates whether this workstation cluster 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 cluster and that are also propagated to the underlying Compute Engine resources.

create_time: Option<Timestamp>

Output only. Time when this workstation cluster was created.

update_time: Option<Timestamp>

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

delete_time: Option<Timestamp>

Output only. Time when this workstation cluster 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.

network: String

Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created.

subnetwork: String

Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.

control_plane_ip: String

Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.

private_cluster_config: Option<PrivateClusterConfig>

Optional. Configuration for private workstation cluster.

domain_config: Option<DomainConfig>

Optional. Configuration options for a custom domain.

degraded: bool

Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster.

conditions: Vec<Status>

Output only. Status conditions describing the workstation cluster’s current state.

tags: HashMap<String, String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: “123/environment”: “production”, “123/costCenter”: “marketing”

gateway_config: Option<GatewayConfig>

Optional. Configuration options for Cluster HTTP Gateway.

workstation_authorization_url: String

Optional. Specifies the redirect URL for unauthorized requests received by workstation VMs in this cluster.

Redirects to this endpoint will send a base64 encoded state query param containing the target workstation name and original request hostname. The endpoint is responsible for retrieving a token using GenerateAccessToken and redirecting back to the original hostname with the token.

workstation_launch_url: String

Optional. Specifies the launch URL for workstations in this cluster. Requests sent to unstarted workstations will be redirected to this URL.

Requests redirected to the launch endpoint will be sent with a workstation and project query parameter containing the full workstation resource name and project ID, respectively. The launch endpoint is responsible for starting the workstation, polling it until it reaches STATE_RUNNING, and then issuing a redirect to the workstation’s host URL.

Implementations

impl WorkstationCluster

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

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

Sets the value of display_name.

Example

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

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

Sets the value of uid.

Example

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

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

Sets the value of reconciling.

Example

let x = WorkstationCluster::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 = WorkstationCluster::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 = WorkstationCluster::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 = WorkstationCluster::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 = WorkstationCluster::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = WorkstationCluster::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 = WorkstationCluster::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 = WorkstationCluster::new().set_or_clear_update_time(Some(Timestamp::default()/* use setters */));
let x = WorkstationCluster::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 = WorkstationCluster::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 = WorkstationCluster::new().set_or_clear_delete_time(Some(Timestamp::default()/* use setters */));
let x = WorkstationCluster::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 = WorkstationCluster::new().set_etag("example");

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

Sets the value of network.

Example

let x = WorkstationCluster::new().set_network("example");

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

Sets the value of subnetwork.

Example

let x = WorkstationCluster::new().set_subnetwork("example");

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

Sets the value of control_plane_ip.

Example

let x = WorkstationCluster::new().set_control_plane_ip("example");

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

where T: Into<PrivateClusterConfig>,

Sets the value of private_cluster_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::PrivateClusterConfig;
let x = WorkstationCluster::new().set_private_cluster_config(PrivateClusterConfig::default()/* use setters */);

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

where T: Into<PrivateClusterConfig>,

Sets or clears the value of private_cluster_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::PrivateClusterConfig;
let x = WorkstationCluster::new().set_or_clear_private_cluster_config(Some(PrivateClusterConfig::default()/* use setters */));
let x = WorkstationCluster::new().set_or_clear_private_cluster_config(None::<PrivateClusterConfig>);

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

where T: Into<DomainConfig>,

Sets the value of domain_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::DomainConfig;
let x = WorkstationCluster::new().set_domain_config(DomainConfig::default()/* use setters */);

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

where T: Into<DomainConfig>,

Sets or clears the value of domain_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::DomainConfig;
let x = WorkstationCluster::new().set_or_clear_domain_config(Some(DomainConfig::default()/* use setters */));
let x = WorkstationCluster::new().set_or_clear_domain_config(None::<DomainConfig>);

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

Sets the value of degraded.

Example

let x = WorkstationCluster::new().set_degraded(true);

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

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

Sets the value of conditions.

Example

use google_cloud_rpc::model::Status;
let x = WorkstationCluster::new()
    .set_conditions([
        Status::default()/* use setters */,
        Status::default()/* use (different) setters */,
    ]);

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

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

Sets the value of tags.

Example

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

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

where T: Into<GatewayConfig>,

Sets the value of gateway_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::GatewayConfig;
let x = WorkstationCluster::new().set_gateway_config(GatewayConfig::default()/* use setters */);

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

where T: Into<GatewayConfig>,

Sets or clears the value of gateway_config.

Example

use google_cloud_workstations_v1::model::workstation_cluster::GatewayConfig;
let x = WorkstationCluster::new().set_or_clear_gateway_config(Some(GatewayConfig::default()/* use setters */));
let x = WorkstationCluster::new().set_or_clear_gateway_config(None::<GatewayConfig>);

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

Sets the value of workstation_authorization_url.

Example

let x = WorkstationCluster::new().set_workstation_authorization_url("example");

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

Sets the value of workstation_launch_url.

Example

let x = WorkstationCluster::new().set_workstation_launch_url("example");

Trait Implementations

impl Clone for WorkstationCluster

fn clone(&self) -> WorkstationCluster

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkstationCluster

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

Formats the value using the given formatter.

impl Default for WorkstationCluster

fn default() -> WorkstationCluster

Returns the “default value” for a type.

impl Message for WorkstationCluster

fn typename() -> &'static str

The typename of this message.

impl PartialEq for WorkstationCluster

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