REST Resource: projects.locations.sessionTemplates

Resource: SessionTemplate

A representation of a session template.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "creator": string,
  "labels": {
    string: string,
    ...
  },
  "runtimeConfig": {
    object (RuntimeConfig)
  },
  "environmentConfig": {
    object (EnvironmentConfig)
  },
  "updateTime": string,
  "uuid": 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. Identifier. The resource name of the session template.
description

string

Optional. Brief description of the template.
createTime

string (Timestamp format)

Output only. The time when the template was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
creator

string

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

map (key: string, value: string)

Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values can be empty, but, if present, must contain 1 to 63 characters and 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 session execution.
environmentConfig

object (EnvironmentConfig)

Optional. Environment configuration for session execution.
updateTime

string (Timestamp format)

Output only. The time the template was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
uuid

string

Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
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.

Methods

create

 Create a session template synchronously.

delete

 Deletes a session template.

get

 Gets the resource representation for a session template.

list

 Lists session templates.

patch

 Updates the session template synchronously.