Struct Instance 

#[non_exhaustive]
pub struct Instance {

    pub name: String,
    pub proxy_uri: String,
    pub instance_owners: Vec<String>,
    pub creator: String,
    pub state: State,
    pub upgrade_history: Vec<UpgradeHistoryEntry>,
    pub id: String,
    pub health_state: HealthState,
    pub health_info: HashMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub disable_proxy_access: bool,
    pub labels: HashMap<String, String>,
    pub infrastructure: Option<Infrastructure>,
    /* private fields */
}

The definition of a notebook 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

Output only. The name of this notebook instance. Format: projects/{project_id}/locations/{location}/instances/{instance_id}

proxy_uri: String

Output only. The proxy endpoint that is used to access the Jupyter notebook.

instance_owners: Vec<String>

Optional. Input only. The owner of this instance after creation. Format: alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance’s service account can use the instance.

creator: String

Output only. Email address of entity that sent original CreateInstance request.

state: State

Output only. The state of this instance.

upgrade_history: Vec<UpgradeHistoryEntry>

Output only. The upgrade history of this instance.

id: String

Output only. Unique ID of the resource.

health_state: HealthState

Output only. Instance health_state.

health_info: HashMap<String, String>

Output only. Additional information about instance health. Example:

healthInfo": {
  "docker_proxy_agent_status": "1",
  "docker_status": "1",
  "jupyterlab_api_status": "-1",
  "jupyterlab_status": "-1",
  "updated": "2020-10-18 09:40:03.573409"
}

create_time: Option<Timestamp>

Output only. Instance creation time.

update_time: Option<Timestamp>

Output only. Instance update time.

disable_proxy_access: bool

Optional. If true, the notebook instance will not register with the proxy.

labels: HashMap<String, String>

Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method.

infrastructure: Option<Infrastructure>

Setup for the Notebook instance.

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_proxy_uri<T: Into<String>>(self, v: T) -> Self

Sets the value of proxy_uri.

Example

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

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

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

Sets the value of instance_owners.

Example

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

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

Sets the value of creator.

Example

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

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

Sets the value of state.

Example

use google_cloud_notebooks_v2::model::State;
let x0 = Instance::new().set_state(State::Starting);
let x1 = Instance::new().set_state(State::Provisioning);
let x2 = Instance::new().set_state(State::Active);

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

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

Sets the value of upgrade_history.

Example

use google_cloud_notebooks_v2::model::UpgradeHistoryEntry;
let x = Instance::new()
    .set_upgrade_history([
        UpgradeHistoryEntry::default()/* use setters */,
        UpgradeHistoryEntry::default()/* use (different) setters */,
    ]);

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

Sets the value of id.

Example

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

pub fn set_health_state<T: Into<HealthState>>(self, v: T) -> Self

Sets the value of health_state.

Example

use google_cloud_notebooks_v2::model::HealthState;
let x0 = Instance::new().set_health_state(HealthState::Healthy);
let x1 = Instance::new().set_health_state(HealthState::Unhealthy);
let x2 = Instance::new().set_health_state(HealthState::AgentNotInstalled);

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

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

Sets the value of health_info.

Example

let x = Instance::new().set_health_info([
    ("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 = 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_disable_proxy_access<T: Into<bool>>(self, v: T) -> Self

Sets the value of disable_proxy_access.

Example

let x = Instance::new().set_disable_proxy_access(true);

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_infrastructure<T: Into<Option<Infrastructure>>>(self, v: T) -> Self

Sets the value of infrastructure.

Note that all the setters affecting infrastructure are mutually exclusive.

Example

use google_cloud_notebooks_v2::model::GceSetup;
let x = Instance::new().set_infrastructure(Some(
    google_cloud_notebooks_v2::model::instance::Infrastructure::GceSetup(GceSetup::default().into())));

pub fn gce_setup(&self) -> Option<&Box<GceSetup>>

The value of infrastructure if it holds a GceSetup, None if the field is not set or holds a different branch.

pub fn set_gce_setup<T: Into<Box<GceSetup>>>(self, v: T) -> Self

Sets the value of infrastructure to hold a GceSetup.

Note that all the setters affecting infrastructure are mutually exclusive.

Example

use google_cloud_notebooks_v2::model::GceSetup;
let x = Instance::new().set_gce_setup(GceSetup::default()/* use setters */);
assert!(x.gce_setup().is_some());

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