Reference documentation and code samples for the Cloud Dataproc V1 API class Google::Cloud::Dataproc::V1::Session.
A representation of a session.
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 session was created.
#creator
def creator() -> ::String
Returns
- (::String) — Output only. The email address of the user who created the session.
#environment_config
def environment_config() -> ::Google::Cloud::Dataproc::V1::EnvironmentConfig
Returns
- (::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for the session execution.
#environment_config=
def environment_config=(value) -> ::Google::Cloud::Dataproc::V1::EnvironmentConfig
Parameter
- value (::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for the session execution.
Returns
- (::Google::Cloud::Dataproc::V1::EnvironmentConfig) — Optional. Environment configuration for the session execution.
#jupyter_session
def jupyter_session() -> ::Google::Cloud::Dataproc::V1::JupyterConfig
Returns
- (::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.
#jupyter_session=
def jupyter_session=(value) -> ::Google::Cloud::Dataproc::V1::JupyterConfig
Parameter
- value (::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.
Returns
- (::Google::Cloud::Dataproc::V1::JupyterConfig) — Optional. Jupyter session config.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::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.
Returns
- (::Google::Protobuf::Map{::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.
#name
def name() -> ::String
Returns
- (::String) — Required. The resource name of the session.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Required. The resource name of the session.
Returns
- (::String) — Required. The resource name of the session.
#runtime_config
def runtime_config() -> ::Google::Cloud::Dataproc::V1::RuntimeConfig
Returns
- (::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for the session execution.
#runtime_config=
def runtime_config=(value) -> ::Google::Cloud::Dataproc::V1::RuntimeConfig
Parameter
- value (::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for the session execution.
Returns
- (::Google::Cloud::Dataproc::V1::RuntimeConfig) — Optional. Runtime configuration for the session execution.
#runtime_info
def runtime_info() -> ::Google::Cloud::Dataproc::V1::RuntimeInfo
Returns
- (::Google::Cloud::Dataproc::V1::RuntimeInfo) — Output only. Runtime information about session execution.
#session_template
def session_template() -> ::String
Returns
-
(::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_template=
def session_template=(value) -> ::String
Parameter
-
value (::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.
Returns
-
(::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.
#state
def state() -> ::Google::Cloud::Dataproc::V1::Session::State
Returns
- (::Google::Cloud::Dataproc::V1::Session::State) — Output only. A state of the session.
#state_history
def state_history() -> ::Array<::Google::Cloud::Dataproc::V1::Session::SessionStateHistory>
Returns
- (::Array<::Google::Cloud::Dataproc::V1::Session::SessionStateHistory>) — Output only. Historical state information for the session.
#state_message
def state_message() -> ::String
Returns
-
(::String) — Output only. Session state details, such as the failure
description if the state is
FAILED.
#state_time
def state_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time when the session entered the current state.
#user
def user() -> ::String
Returns
- (::String) — Optional. The email address of the user who owns the session.
#user=
def user=(value) -> ::String
Parameter
- value (::String) — Optional. The email address of the user who owns the session.
Returns
- (::String) — Optional. The email address of the user who owns the session.
#uuid
def uuid() -> ::String
Returns
- (::String) — Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.