REST Resource: projects.locations.sessions

资源：会话

会话的表示法。

JSON 表示法 
{
  "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.
}
字段
name

string

必需。会话的资源名称。
uuid

string

仅限输出。会话 UUID（通用唯一标识符）。该服务会在创建会话时生成此值。
createTime

string (Timestamp format)

仅限输出。会话的创建时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
runtimeInfo

object (RuntimeInfo)

仅限输出。有关会话执行的运行时信息。
state

enum (State)

仅限输出。会话的状态。
stateMessage

string

仅限输出。会话状态详情，例如如果状态为 FAILED，则会显示失败说明。
stateTime

string (Timestamp format)

仅限输出。会话进入当前状态的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。
creator

string

仅限输出。创建会话的用户的电子邮件地址。
labels

map (key: string, value: string)

可选。要与会话相关联的标签。标签键必须包含 1 到 63 个字符，并且必须符合 RFC 1035 的要求。标签值可以为空，但如果存在，则必须包含 1 到 63 个字符，并且必须符合 RFC 1035。与会话关联的标签不得超过 32 个。

包含一系列 "key": value 对的对象。示例：{ "name": "wrench", "mass": "1.3kg", "count": "3" }。
runtimeConfig

object (RuntimeConfig)

可选。会话执行的运行时配置。
environmentConfig

object (EnvironmentConfig)

可选。会话执行的环境配置。
user

string

可选。会话所有者的电子邮件地址。
stateHistory[]

object (SessionStateHistory)

仅限输出。会话的历史状态信息。
sessionTemplate

string

可选。会话使用的会话模板。

只有资源名称（包括项目 ID 和位置）才有效。

示例：* https://www.googleapis.com/compute/v1/projects/[projectId]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[projectId]/locations/[dataproc_region]/sessionTemplates/[template_id]

模板必须与会话位于同一项目和 Dataproc 区域。
联合字段 session_config。会话配置。session_config 只能是下列其中一项：
jupyterSession

object (JupyterConfig)

可选。Jupyter 会话配置。
sparkConnectSession

object (SparkConnectConfig)

可选。Spark 连接会话配置。

州

会话状态。

枚举
STATE_UNSPECIFIED 会话状态未知。
CREATING 会话是在运行前创建的。
ACTIVE 会话正在运行。
TERMINATING 会话正在终止。
TERMINATED 会话已成功终止。
FAILED 由于出现错误，会话已停止运行。

SessionStateHistory

历史状态信息。

JSON 表示法 
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
字段
state

enum (State)

仅限输出。会话历史记录中此时刻的会话状态。
stateMessage

string

仅限输出。有关会话历史记录中此时刻状态的详细信息。
stateStartTime

string (Timestamp format)

仅限输出。会话进入历史状态的时间。

时间戳采用 RFC3339 世界协调时间（UTC，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

方法

create

 异步创建交互式会话。

delete

 删除交互式会话资源。

get

 获取交互式会话的资源表示法。

list

 列出交互式会话。

terminate

 终止交互式会话。