Struct SessionTemplate 

#[non_exhaustive]
pub struct SessionTemplate {
    pub name: String,
    pub description: String,
    pub create_time: Option<Timestamp>,
    pub creator: String,
    pub labels: HashMap<String, String>,
    pub runtime_config: Option<RuntimeConfig>,
    pub environment_config: Option<EnvironmentConfig>,
    pub update_time: Option<Timestamp>,
    pub uuid: String,
    pub session_config: Option<SessionConfig>,
    /* private fields */
}

A representation of a session template.

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

Required. Identifier. The resource name of the session template.

description: String

Optional. Brief description of the template.

create_time: Option<Timestamp>

Output only. The time when the template was created.

creator: String

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

labels: HashMap<String, String>

Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035. No more than 32 labels can be associated with a session.

runtime_config: Option<RuntimeConfig>

Optional. Runtime configuration for session execution.

environment_config: Option<EnvironmentConfig>

Optional. Environment configuration for session execution.

update_time: Option<Timestamp>

Output only. The time the template was last updated.

uuid: String

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

session_config: Option<SessionConfig>

The session configuration.

Implementations

impl SessionTemplate

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

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

Sets the value of description.

Example

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

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

Sets the value of creator.

Example

let x = SessionTemplate::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 = SessionTemplate::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 = SessionTemplate::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 = SessionTemplate::new().set_or_clear_runtime_config(Some(RuntimeConfig::default()/* use setters */));
let x = SessionTemplate::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 = SessionTemplate::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 = SessionTemplate::new().set_or_clear_environment_config(Some(EnvironmentConfig::default()/* use setters */));
let x = SessionTemplate::new().set_or_clear_environment_config(None::<EnvironmentConfig>);

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

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

Sets the value of uuid.

Example

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

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 = SessionTemplate::new().set_session_config(Some(
    google_cloud_dataproc_v1::model::session_template::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 = SessionTemplate::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 = SessionTemplate::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 SessionTemplate

fn clone(&self) -> SessionTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionTemplate

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

Formats the value using the given formatter.

impl Default for SessionTemplate

fn default() -> SessionTemplate

Returns the “default value” for a type.

impl Message for SessionTemplate

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SessionTemplate

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SessionTemplate