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 (通用專屬 ID)。服務會在建立工作階段時產生這個值。
createTime

string (Timestamp format)

僅供輸出。建立工作階段的時間。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："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 Connect 工作階段設定。

狀態

工作階段狀態。

列舉
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 世界標準時間「Zulu」格式的時間戳記，精確度達奈秒單位，最多九個小數位數。例如："2014-10-02T15:01:23Z" 和 "2014-10-02T15:01:23.045123456Z"。

方法

create

 以非同步方式建立互動工作階段。

delete

 刪除互動工作階段資源。

get

 取得互動工作階段的資源表示法。

list

 列出互動工作階段。

terminate

 終止互動工作階段。