REST Resource: projects.locations.sessions

Resource: Session

A representation of a session.

JSON representation 
{
  "name": string,
  "uuid": string,
  "createTime": string,
  "runtimeInfo": {
    object (RuntimeInfo)
  },
  "state": enum (State),
  "stateMessage": string,
  "stateTime": string,
  "creator": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeConfig": {
    object (RuntimeConfig)
  },
  "environmentConfig": {
    object (EnvironmentConfig)
  },
  "user": string,
  "stateHistory": [
    {
      object (SessionStateHistory)
    }
  ],
  "sessionTemplate": string,

  // Union field session_config can be only one of the following:
  "jupyterSession": {
    object (JupyterConfig)
  },
  "sparkConnectSession": {
    object (SparkConnectConfig)
  }
  // End of list of possible types for union field session_config.
}
Fields
name

string

Required. The resource name of the session.
uuid

string

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

string (Timestamp format)

Output only. The time when the session was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
runtimeInfo

object (RuntimeInfo)

Output only. Runtime information about session execution.
state

enum (State)

Output only. A state of the session.
stateMessage

string

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

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
creator

string

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

map (key: string, value: 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runtimeConfig

object (RuntimeConfig)

Optional. Runtime configuration for the session execution.
environmentConfig

object (EnvironmentConfig)

Optional. Environment configuration for the session execution.
user

string

Optional. The email address of the user who owns the session.
stateHistory[]

object (SessionStateHistory)

Output only. Historical state information for the session.
sessionTemplate

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/[projectId]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[projectId]/locations/[dataproc_region]/sessionTemplates/[template_id]

The template must be in the same project and Dataproc region as the session.
Union field session_config. The session configuration. session_config can be only one of the following:
jupyterSession

object (JupyterConfig)

Optional. Jupyter session config.
sparkConnectSession

object (SparkConnectConfig)

Optional. Spark connect session config.

State

The session state.

Enums
STATE_UNSPECIFIED The session state is unknown.
CREATING The session is created prior to running.
ACTIVE The session is running.
TERMINATING The session is terminating.
TERMINATED The session is terminated successfully.
FAILED The session is no longer running due to an error.

SessionStateHistory

Historical state information.

JSON representation 
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
Fields
state

enum (State)

Output only. The state of the session at this point in the session history.
stateMessage

string

Output only. Details about the state at this point in the session history.
stateStartTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

create

 Create an interactive session asynchronously.

delete

 Deletes the interactive session resource.

get

 Gets the resource representation for an interactive session.

list

 Lists interactive sessions.

terminate

 Terminates the interactive session.