Struct Session 

#[non_exhaustive]
pub struct Session {

    pub name: String,
    pub uuid: String,
    pub create_time: Option<Timestamp>,
    pub runtime_info: Option<RuntimeInfo>,
    pub state: State,
    pub state_message: String,
    pub state_time: Option<Timestamp>,
    pub creator: String,
    pub labels: HashMap<String, String>,
    pub runtime_config: Option<RuntimeConfig>,
    pub environment_config: Option<EnvironmentConfig>,
    pub user: String,
    pub state_history: Vec<SessionStateHistory>,
    pub session_template: String,
    pub session_config: Option<SessionConfig>,
    /* private fields */
}

A representation of a session.

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. The resource name of the session.

uuid: String

Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.

create_time: Option<Timestamp>

Output only. The time when the session was created.

runtime_info: Option<RuntimeInfo>

Output only. Runtime information about session execution.

state: State

Output only. A state of the session.

state_message: String

Output only. Session state details, such as the failure description if the state is FAILED.

state_time: Option<Timestamp>

Output only. The time when the session entered the current state.

creator: String

Output only. The email address of the user who created the session.

labels: HashMap<String, String>

Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a session.

runtime_config: Option<RuntimeConfig>

Optional. Runtime configuration for the session execution.

environment_config: Option<EnvironmentConfig>

Optional. Environment configuration for the session execution.

user: String

Optional. The email address of the user who owns the session.

state_history: Vec<SessionStateHistory>

Output only. Historical state information for the session.

session_template: String

Optional. The session template used by the session.

Only resource names, including project ID and location, are valid.

Example:

• <https://www.googleapis.com/compute/v1/projects/>[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]
• projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]

The template must be in the same project and Dataproc region as the session.

session_config: Option<SessionConfig>

The session configuration.

Implementations

impl Session

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

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

Sets the value of uuid.

Example

let x = Session::new().set_uuid("example");

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

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

where T: Into<RuntimeInfo>,

Sets the value of runtime_info.

Example

use google_cloud_dataproc_v1::model::RuntimeInfo;
let x = Session::new().set_runtime_info(RuntimeInfo::default()/* use setters */);

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

where T: Into<RuntimeInfo>,

Sets or clears the value of runtime_info.

Example

use google_cloud_dataproc_v1::model::RuntimeInfo;
let x = Session::new().set_or_clear_runtime_info(Some(RuntimeInfo::default()/* use setters */));
let x = Session::new().set_or_clear_runtime_info(None::<RuntimeInfo>);

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

Sets the value of state.

Example

use google_cloud_dataproc_v1::model::session::State;
let x0 = Session::new().set_state(State::Creating);
let x1 = Session::new().set_state(State::Active);
let x2 = Session::new().set_state(State::Terminating);

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

Sets the value of state_message.

Example

let x = Session::new().set_state_message("example");

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

where T: Into<Timestamp>,

Sets the value of state_time.

Example

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

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

where T: Into<Timestamp>,

Sets or clears the value of state_time.

Example

use wkt::Timestamp;
let x = Session::new().set_or_clear_state_time(Some(Timestamp::default()/* use setters */));
let x = Session::new().set_or_clear_state_time(None::<Timestamp>);

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

Sets the value of creator.

Example

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

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

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

where T: Into<RuntimeConfig>,

Sets the value of runtime_config.

Example

use google_cloud_dataproc_v1::model::RuntimeConfig;
let x = Session::new().set_runtime_config(RuntimeConfig::default()/* use setters */);

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

where T: Into<RuntimeConfig>,

Sets or clears the value of runtime_config.

Example

use google_cloud_dataproc_v1::model::RuntimeConfig;
let x = Session::new().set_or_clear_runtime_config(Some(RuntimeConfig::default()/* use setters */));
let x = Session::new().set_or_clear_runtime_config(None::<RuntimeConfig>);

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

where T: Into<EnvironmentConfig>,

Sets the value of environment_config.

Example

use google_cloud_dataproc_v1::model::EnvironmentConfig;
let x = Session::new().set_environment_config(EnvironmentConfig::default()/* use setters */);

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

where T: Into<EnvironmentConfig>,

Sets or clears the value of environment_config.

Example

use google_cloud_dataproc_v1::model::EnvironmentConfig;
let x = Session::new().set_or_clear_environment_config(Some(EnvironmentConfig::default()/* use setters */));
let x = Session::new().set_or_clear_environment_config(None::<EnvironmentConfig>);

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

Sets the value of user.

Example

let x = Session::new().set_user("example");

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

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

Sets the value of state_history.

Example

use google_cloud_dataproc_v1::model::session::SessionStateHistory;
let x = Session::new()
    .set_state_history([
        SessionStateHistory::default()/* use setters */,
        SessionStateHistory::default()/* use (different) setters */,
    ]);

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

Sets the value of session_template.

Example

let x = Session::new().set_session_template(format!("projects/{project_id}/locations/{location_id}/sessionTemplates/{template_id}"));

pub fn set_session_config<T: Into<Option<SessionConfig>>>(self, v: T) -> Self

Sets the value of session_config.

Note that all the setters affecting session_config are mutually exclusive.

Example

use google_cloud_dataproc_v1::model::JupyterConfig;
let x = Session::new().set_session_config(Some(
    google_cloud_dataproc_v1::model::session::SessionConfig::JupyterSession(JupyterConfig::default().into())));

pub fn jupyter_session(&self) -> Option<&Box<JupyterConfig>>

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

pub fn set_jupyter_session<T: Into<Box<JupyterConfig>>>(self, v: T) -> Self

Sets the value of session_config to hold a JupyterSession.

Note that all the setters affecting session_config are mutually exclusive.

Example

use google_cloud_dataproc_v1::model::JupyterConfig;
let x = Session::new().set_jupyter_session(JupyterConfig::default()/* use setters */);
assert!(x.jupyter_session().is_some());
assert!(x.spark_connect_session().is_none());

pub fn spark_connect_session(&self) -> Option<&Box<SparkConnectConfig>>

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

pub fn set_spark_connect_session<T: Into<Box<SparkConnectConfig>>>( self, v: T, ) -> Self

Sets the value of session_config to hold a SparkConnectSession.

Note that all the setters affecting session_config are mutually exclusive.

Example

use google_cloud_dataproc_v1::model::SparkConnectConfig;
let x = Session::new().set_spark_connect_session(SparkConnectConfig::default()/* use setters */);
assert!(x.spark_connect_session().is_some());
assert!(x.jupyter_session().is_none());

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.

impl Message for Session

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Session

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Session