Google Cloud Dataproc v1 API - Class Session (5.16.0)

public sealed class Session : IMessage<Session>, IEquatable<Session>, IDeepCloneable<Session>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dataproc v1 API class Session.

A representation of a session.

Inheritance

object > Session

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

Session()

public Session()

Session(Session)

public Session(Session other)
Parameter
Name Description
other Session

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The time when the session was created.

Property Value
Type Description
Timestamp

Creator

public string Creator { get; set; }

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

Property Value
Type Description
string

EnvironmentConfig

public EnvironmentConfig EnvironmentConfig { get; set; }

Optional. Environment configuration for the session execution.

Property Value
Type Description
EnvironmentConfig

JupyterSession

public JupyterConfig JupyterSession { get; set; }

Optional. Jupyter session config.

Property Value
Type Description
JupyterConfig

Labels

public MapField<string, string> Labels { get; }

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.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Required. The resource name of the session.

Property Value
Type Description
string

RuntimeConfig

public RuntimeConfig RuntimeConfig { get; set; }

Optional. Runtime configuration for the session execution.

Property Value
Type Description
RuntimeConfig

RuntimeInfo

public RuntimeInfo RuntimeInfo { get; set; }

Output only. Runtime information about session execution.

Property Value
Type Description
RuntimeInfo

SessionConfigCase

public Session.SessionConfigOneofCase SessionConfigCase { get; }
Property Value
Type Description
SessionSessionConfigOneofCase

SessionName

public SessionName SessionName { get; set; }

SessionName-typed view over the Name resource name property.

Property Value
Type Description
SessionName

SessionTemplate

public string SessionTemplate { get; set; }

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.

Property Value
Type Description
string

SessionTemplateAsSessionTemplateName

public SessionTemplateName SessionTemplateAsSessionTemplateName { get; set; }

SessionTemplateName-typed view over the SessionTemplate resource name property.

Property Value
Type Description
SessionTemplateName

SparkConnectSession

public SparkConnectConfig SparkConnectSession { get; set; }

Optional. Spark Connect session config.

Property Value
Type Description
SparkConnectConfig

State

public Session.Types.State State { get; set; }

Output only. A state of the session.

Property Value
Type Description
SessionTypesState

StateHistory

public RepeatedField<Session.Types.SessionStateHistory> StateHistory { get; }

Output only. Historical state information for the session.

Property Value
Type Description
RepeatedFieldSessionTypesSessionStateHistory

StateMessage

public string StateMessage { get; set; }

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

Property Value
Type Description
string

StateTime

public Timestamp StateTime { get; set; }

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

Property Value
Type Description
Timestamp

User

public string User { get; set; }

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

Property Value
Type Description
string

Uuid

public string Uuid { get; set; }

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

Property Value
Type Description
string