Struct Environment 

#[non_exhaustive]
pub struct Environment {
    pub name: String,
    pub id: String,
    pub docker_image: String,
    pub state: State,
    pub web_host: String,
    pub ssh_username: String,
    pub ssh_host: String,
    pub ssh_port: i32,
    pub public_keys: Vec<String>,
    /* private fields */
}

A Cloud Shell environment, which is defined as the combination of a Docker image specifying what is installed on the environment and a home directory containing the user’s data that will remain across sessions. Each user has at least an environment with the ID “default”.

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. Full name of this resource, in the format users/{owner_email}/environments/{environment_id}. {owner_email} is the email address of the user to whom this environment belongs, and {environment_id} is the identifier of this environment. For example, users/someone@example.com/environments/default.

id: String

Output only. The environment’s identifier, unique among the user’s environments.

docker_image: String

Required. Immutable. Full path to the Docker image used to run this environment, e.g. “gcr.io/dev-con/cloud-devshell:latest”.

state: State

Output only. Current execution state of this environment.

web_host: String

Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment.

ssh_username: String

Output only. Username that clients should use when initiating SSH sessions with the environment.

ssh_host: String

Output only. Host to which clients can connect to initiate SSH sessions with the environment.

ssh_port: i32

Output only. Port to which clients can connect to initiate SSH sessions with the environment.

public_keys: Vec<String>

Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods.

Implementations

impl Environment

pub fn new() -> Self

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

Sets the value of name.

Example

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

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

Sets the value of id.

Example

let x = Environment::new().set_id("example");

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

Sets the value of docker_image.

Example

let x = Environment::new().set_docker_image("example");

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

Sets the value of state.

Example

use google_cloud_shell_v1::model::environment::State;
let x0 = Environment::new().set_state(State::Suspended);
let x1 = Environment::new().set_state(State::Pending);
let x2 = Environment::new().set_state(State::Running);

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

Sets the value of web_host.

Example

let x = Environment::new().set_web_host("example");

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

Sets the value of ssh_username.

Example

let x = Environment::new().set_ssh_username("example");

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

Sets the value of ssh_host.

Example

let x = Environment::new().set_ssh_host("example");

pub fn set_ssh_port<T: Into<i32>>(self, v: T) -> Self

Sets the value of ssh_port.

Example

let x = Environment::new().set_ssh_port(42);

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

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

Sets the value of public_keys.

Example

let x = Environment::new().set_public_keys(["a", "b", "c"]);

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Environment

Returns the “default value” for a type.

impl Message for Environment

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Environment

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