Class Session (5.14.0)

Version 5.14.0

• 5.16.0 (latest)
• 5.15.1
• 5.14.0
• 5.13.0
• 5.12.0
• 5.10.2
• 5.9.3
• 5.8.0
• 5.7.0
• 5.6.0
• 5.5.1
• 5.4.3
• 5.3.0
• 5.2.0
• 5.1.0
• 5.0.3
• 4.0.3
• 3.3.2
• 3.2.0
• 3.1.1
• 3.0.0
• 2.6.2
• 2.5.0
• 2.4.0
• 2.3.1
• 2.2.0
• 2.0.2
• 1.1.3
• 1.0.1
• 0.8.2
• 0.7.0
• 0.6.1
• 0.5.0

Session(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A representation of a session.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
name	str Required. The resource name of the session.
uuid	str Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time when the session was created.
jupyter_session	google.cloud.dataproc_v1.types.JupyterConfig Optional. Jupyter session config. This field is a member of oneof_ session_config.
spark_connect_session	google.cloud.dataproc_v1.types.SparkConnectConfig Optional. Spark Connect session config. This field is a member of oneof_ session_config.
runtime_info	google.cloud.dataproc_v1.types.RuntimeInfo Output only. Runtime information about session execution.
state	google.cloud.dataproc_v1.types.Session.State Output only. A state of the session.
state_message	str Output only. Session state details, such as the failure description if the state is FAILED.
state_time	google.protobuf.timestamp_pb2.Timestamp Output only. The time when the session entered the current state.
creator	str Output only. The email address of the user who created the session.
labels	MutableMapping[str, str] 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
runtime_config	google.cloud.dataproc_v1.types.RuntimeConfig Optional. Runtime configuration for the session execution.
environment_config	google.cloud.dataproc_v1.types.EnvironmentConfig Optional. Environment configuration for the session execution.
user	str Optional. The email address of the user who owns the session.
state_history	MutableSequence[google.cloud.dataproc_v1.types.Session.SessionStateHistory] Output only. Historical state information for the session.
session_template	str 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.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

SessionStateHistory

SessionStateHistory(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Historical state information.

State

State(value)

The session state.