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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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 に準拠している必要があります。1 つのセッションに関連付けることができるラベルは 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 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

メソッド

create

 インタラクティブ セッションを非同期で作成します。

delete

 インタラクティブ セッション リソースを削除します。

get

 インタラクティブ セッションのリソース表現を取得します。

list

 インタラクティブ セッションを一覧表示します。

terminate

 インタラクティブ セッションを終了します。