Cloud Dataproc V1 API - Class Google::Cloud::Dataproc::V1::SessionTemplate (v1.2.0)

Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::SessionTemplate.

A representation of a session template.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time when the template was created.

#creator

def creator() -> ::String

Returns

(::String) — Output only. The email address of the user who created the template.

#description

def description() -> ::String

Returns

(::String) — Optional. Brief description of the template.

#description=

def description=(value) -> ::String

Parameter

value (::String) — Optional. Brief description of the template.

Returns

(::String) — Optional. Brief description of the template.

#environment_config

def environment_config() -> ::Google::Cloud::Dataproc::V1::EnvironmentConfig

Returns

(::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for session execution.

#environment_config=

def environment_config=(value) -> ::Google::Cloud::Dataproc::V1::EnvironmentConfig

Parameter

value (::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for session execution.

Returns

(::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for session execution.

#jupyter_session

def jupyter_session() -> ::Google::Cloud::Dataproc::V1::JupyterConfig

Returns

(::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.

Note: The following fields are mutually exclusive: jupyter_session, spark_connect_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#jupyter_session=

def jupyter_session=(value) -> ::Google::Cloud::Dataproc::V1::JupyterConfig

Parameter

value (::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.

Note: The following fields are mutually exclusive: jupyter_session, spark_connect_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.

Note: The following fields are mutually exclusive: jupyter_session, spark_connect_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::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.

Returns

(::Google::Protobuf::Map{::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.

#name

def name() -> ::String

Returns

(::String) — Required. The resource name of the session template.

#name=

def name=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the session template.

Returns

(::String) — Required. The resource name of the session template.

#runtime_config

def runtime_config() -> ::Google::Cloud::Dataproc::V1::RuntimeConfig

Returns

(::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for session execution.

#runtime_config=

def runtime_config=(value) -> ::Google::Cloud::Dataproc::V1::RuntimeConfig

Parameter

value (::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for session execution.

Returns

(::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for session execution.

#spark_connect_session

def spark_connect_session() -> ::Google::Cloud::Dataproc::V1::SparkConnectConfig

Returns

(::Google::Cloud::Dataproc::V1::SparkConnectConfig) — Optional. Spark Connect session config.

Note: The following fields are mutually exclusive: spark_connect_session, jupyter_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#spark_connect_session=

def spark_connect_session=(value) -> ::Google::Cloud::Dataproc::V1::SparkConnectConfig

Parameter

value (::Google::Cloud::Dataproc::V1::SparkConnectConfig) — Optional. Spark Connect session config.

Note: The following fields are mutually exclusive: spark_connect_session, jupyter_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Dataproc::V1::SparkConnectConfig) — Optional. Spark Connect session config.

Note: The following fields are mutually exclusive: spark_connect_session, jupyter_session. If a field in that set is populated, all other fields in the set will automatically be cleared.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the template was last updated.

#uuid

def uuid() -> ::String

Returns

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