Resource: Session
A representation of a session.
JSON representation |
---|
{ "name": string, "uuid": string, "createTime": string, "runtimeInfo": { object ( |
Fields | |
---|---|
name |
Required. The resource name of the session. |
uuid |
Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. |
createTime |
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: |
runtimeInfo |
Output only. Runtime information about session execution. |
state |
Output only. A state of the session. |
stateMessage |
Output only. Session state details, such as the failure description if the state is |
stateTime |
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: |
creator |
Output only. The email address of the user who created the session. |
labels |
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 |
runtimeConfig |
Optional. Runtime configuration for the session execution. |
environmentConfig |
Optional. Environment configuration for the session execution. |
user |
Optional. The email address of the user who owns the session. |
stateHistory[] |
Output only. Historical state information for the session. |
sessionTemplate |
Optional. The session template used by the session. Only resource names, including project ID and location, are valid. Example: * 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 |
Optional. Jupyter 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 ( |
Fields | |
---|---|
state |
Output only. The state of the session at this point in the session history. |
stateMessage |
Output only. Details about the state at this point in the session history. |
stateStartTime |
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: |
Methods |
|
---|---|
|
Create an interactive session asynchronously. |
|
Deletes the interactive session resource. |
|
Gets the resource representation for an interactive session. |
|
Lists interactive sessions. |
|
Terminates the interactive session. |