Struct google_api_proto::google::cloud::notebooks::v2::Instance

pub struct Instance {

    pub name: String,
    pub proxy_uri: String,
    pub instance_owners: Vec<String>,
    pub creator: String,
    pub state: i32,
    pub upgrade_history: Vec<UpgradeHistoryEntry>,
    pub id: String,
    pub health_state: i32,
    pub health_info: BTreeMap<String, String>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub disable_proxy_access: bool,
    pub labels: BTreeMap<String, String>,
    pub infrastructure: Option<Infrastructure>,
}

The definition of a notebook instance.

Fields

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: i32

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: i32

Output only. Instance health_state.

health_info: BTreeMap<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: BTreeMap<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 state(&self) -> State

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: State)

Sets state to the provided enum value.

pub fn health_state(&self) -> HealthState

Returns the enum value of health_state, or the default if the field is set to an invalid enum value.

pub fn set_health_state(&mut self, value: HealthState)

Sets health_state to the provided enum value.

Trait Implementations

impl Clone for Instance

fn clone(&self) -> Instance

Returns a copy 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() -> Self

Returns the “default value” for a type.

impl Message for Instance

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Instance

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Instance