REST Resource: projects.locations.sessions

Ressource: Session

Représentation d'une session.

Représentation 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.
}
Champs
name

string

Obligatoire. Nom de la ressource de la session.

uuid

string

Uniquement en sortie. Un UUID (identifiant unique universel) de session. Le service génère cette valeur lorsqu'il crée la session.

createTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la session a été créée.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

runtimeInfo

object (RuntimeInfo)

Uniquement en sortie. Informations d'exécution sur l'exécution de la session.

state

enum (State)

Uniquement en sortie. État de la session.

stateMessage

string

Uniquement en sortie. Détails de l'état de la session, tels que la description de l'échec si l'état est FAILED.

stateTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la session est passée à l'état actuel.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

creator

string

Uniquement en sortie. Adresse e-mail de l'utilisateur qui a créé la session.

labels

map (key: string, value: string)

Facultatif. Libellés à associer à la session. Les clés d'étiquette doivent contenir entre 1 et 63 caractères et être conformes à la RFC 1035. Les valeurs des libellés peuvent être vides, mais, si elles sont présentes, elles doivent comporter entre 1 et 63 caractères et être conformes à la norme RFC 1035. Vous ne pouvez pas associer plus de 32 libellés à une session.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runtimeConfig

object (RuntimeConfig)

Facultatif. Configuration de l'environnement d'exécution pour l'exécution de la session.

environmentConfig

object (EnvironmentConfig)

Facultatif. Configuration de l'environnement pour l'exécution de la session.

user

string

Facultatif. Adresse e-mail de l'utilisateur propriétaire de la session.

stateHistory[]

object (SessionStateHistory)

Uniquement en sortie. Informations sur l'historique de l'état de la session.

sessionTemplate

string

Facultatif. Modèle de session utilisé par la session.

Seuls les noms de ressources, y compris l'ID et l'emplacement du projet, sont valides.

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

Le modèle doit se trouver dans le même projet et la même région Dataproc que la session.

Champ d'union session_config. Configuration de la session. session_config ne peut être qu'un des éléments suivants :
jupyterSession

object (JupyterConfig)

Facultatif. Configuration de la session Jupyter.

sparkConnectSession

object (SparkConnectConfig)

Facultatif. Configuration de la session Spark Connect.

État

État de la session.

Enums
STATE_UNSPECIFIED L'état de la session est inconnu.
CREATING La session est créée avant l'exécution.
ACTIVE La session est en cours d'exécution.
TERMINATING La session se termine.
TERMINATED La session est arrêtée.
FAILED La session n'est plus en cours d'exécution en raison d'une erreur.

SessionStateHistory

Informations sur l'état historique.

Représentation JSON
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
Champs
state

enum (State)

Uniquement en sortie. État de la session à ce stade de l'historique de la session.

stateMessage

string

Uniquement en sortie. Informations sur l'état à ce stade de l'historique de la session.

stateStartTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la session est passée à l'état "historique".

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

Méthodes

create

Créez une session interactive de manière asynchrone.

delete

Supprime la ressource de session interactive.

get

Récupère la représentation de la ressource pour une session interactive.

list

Liste les sessions interactives.

terminate

Arrête la session interactive.