REST Resource: projects.locations.sessions

Ressource: Sitzung

Eine Darstellung einer Sitzung.

JSON-Darstellung
{
  "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.
}
Felder
name

string

Pflichtangabe. Der Ressourcenname der Sitzung.

uuid

string

Nur Ausgabe. Eine Sitzungs-UUID (Unique Universal Identifier). Der Dienst generiert diesen Wert, wenn er die Sitzung erstellt.

createTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung erstellt wurde.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

runtimeInfo

object (RuntimeInfo)

Nur Ausgabe. Laufzeitinformationen zur Sitzungsausführung.

state

enum (State)

Nur Ausgabe. Ein Sitzungsstatus.

stateMessage

string

Nur Ausgabe. Details zum Sitzungsstatus, z. B. die Fehlerbeschreibung, wenn der Status FAILED ist.

stateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Sitzung den aktuellen Status erreicht hat.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

creator

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers, der die Sitzung erstellt hat.

labels

map (key: string, value: string)

Optional. Die Labels, die der Sitzung zugeordnet werden sollen. Labelschlüssel müssen zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Labelwerte können leer sein. Wenn sie vorhanden sind, müssen sie zwischen 1 und 63 Zeichen lang sein und RFC 1035 entsprechen. Einer Sitzung können maximal 32 Labels zugeordnet werden.

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runtimeConfig

object (RuntimeConfig)

Optional. Laufzeitkonfiguration für die Sitzungsausführung.

environmentConfig

object (EnvironmentConfig)

Optional. Umgebungskonfiguration für die Sitzungsausführung.

user

string

Optional. Die E-Mail-Adresse des Nutzers, dem die Sitzung gehört.

stateHistory[]

object (SessionStateHistory)

Nur Ausgabe. Informationen zum bisherigen Status der Sitzung.

sessionTemplate

string

Optional. Die von der Sitzung verwendete Sitzungsvorlage.

Nur Ressourcennamen, einschließlich Projekt-ID und Standort, sind zulässig.

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

Die Vorlage muss sich im selben Projekt und in derselben Dataproc-Region wie die Sitzung befinden.

Union-Feld session_config. Die Sitzungskonfiguration. Für session_config ist nur einer der folgenden Werte zulässig:
jupyterSession

object (JupyterConfig)

Optional. Konfiguration der Jupyter-Sitzung.

sparkConnectSession

object (SparkConnectConfig)

Optional. Konfiguration der Spark Connect-Sitzung.

Bundesland

Der Sitzungsstatus.

Enums
STATE_UNSPECIFIED Der Sitzungsstatus ist unbekannt.
CREATING Die Sitzung wird vor dem Ausführen erstellt.
ACTIVE Die Sitzung wird ausgeführt.
TERMINATING Die Sitzung wird beendet.
TERMINATED Die Sitzung wird beendet.
FAILED Die Sitzung wird aufgrund eines Fehlers nicht mehr ausgeführt.

SessionStateHistory

Informationen zum bisherigen Status.

JSON-Darstellung
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
Felder
state

enum (State)

Nur Ausgabe. Der Status der Sitzung an diesem Punkt im Sitzungsverlauf.

stateMessage

string

Nur Ausgabe. Details zum Status an diesem Punkt im Sitzungsverlauf.

stateStartTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Sitzung in den bisherigen Status gewechselt ist.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".

Methoden

create

Interaktive Sitzungen asynchron erstellen

delete

Löscht die Ressource für die interaktive Sitzung.

get

Ruft die Ressourcendarstellung für eine interaktive Sitzung ab.

list

Hier werden interaktive Sitzungen aufgelistet.

terminate

Beendet die interaktive Sitzung.