REST Resource: projects.locations.sessions

Recurso: Sesión

Es una representación de una sesión.

Representación 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.
}
Campos
name

string

Obligatorio. Es el nombre del recurso de la sesión.

uuid

string

Solo salida. Un UUID de sesión (identificador único universal). El servicio genera este valor cuando crea la sesión.

createTime

string (Timestamp format)

Solo salida. Es la hora en la que se creó la sesión.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

runtimeInfo

object (RuntimeInfo)

Solo salida. Información del entorno de ejecución sobre la ejecución de la sesión.

state

enum (State)

Solo salida. Un estado de la sesión.

stateMessage

string

Solo salida. Detalles del estado de la sesión, como la descripción de la falla si el estado es FAILED

stateTime

string (Timestamp format)

Solo salida. Es la hora en que la sesión entró en el estado actual.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

creator

string

Solo salida. Es la dirección de correo electrónico del usuario que creó la sesión.

labels

map (key: string, value: string)

Opcional. Las etiquetas que se asociarán con la sesión. Las claves de etiqueta deben contener entre 1 y 63 caracteres y cumplir con la RFC 1035. Los valores de la etiqueta pueden estar vacíos, pero, si están presentes, deben contener entre 1 y 63 caracteres y cumplir con la RFC 1035. No se pueden asociar más de 32 etiquetas a una sesión.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runtimeConfig

object (RuntimeConfig)

Opcional. Configuración del entorno de ejecución para la ejecución de la sesión.

environmentConfig

object (EnvironmentConfig)

Opcional. Configuración del entorno para la ejecución de la sesión.

user

string

Opcional. Es la dirección de correo electrónico del usuario propietario de la sesión.

stateHistory[]

object (SessionStateHistory)

Solo salida. Información histórica del estado de la sesión.

sessionTemplate

string

Opcional. Es la plantilla de sesión que usa la sesión.

Solo son válidos los nombres de los recursos, incluidos el ID y la ubicación del proyecto.

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

La plantilla debe estar en el mismo proyecto y la misma región de Dataproc que la sesión.

Campo de unión session_config. La configuración de la sesión. session_config puede ser solo uno de los siguientes:
jupyterSession

object (JupyterConfig)

Opcional. Configuración de la sesión de Jupyter

sparkConnectSession

object (SparkConnectConfig)

Opcional. Configuración de la sesión de Spark Connect.

Estado

El estado de la sesión.

Enums
STATE_UNSPECIFIED Se desconoce el estado de la sesión.
CREATING La sesión se crea antes de ejecutarse.
ACTIVE La sesión se está ejecutando.
TERMINATING La sesión finalizará.
TERMINATED La sesión finaliza correctamente.
FAILED La sesión ya no se está ejecutando debido a un error.

SessionStateHistory

Información histórica del estado.

Representación JSON
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
Campos
state

enum (State)

Solo salida. Es el estado de la sesión en este punto del historial de la sesión.

stateMessage

string

Solo salida. Detalles sobre el estado en este punto del historial de la sesión.

stateStartTime

string (Timestamp format)

Solo salida. Es la hora en la que la sesión entró en el estado histórico.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Métodos

create

Crea una sesión interactiva de forma asíncrona.

delete

Borra el recurso de sesión interactiva.

get

Obtiene la representación de recursos para una sesión interactiva.

list

Muestra una lista de las sesiones interactivas.

terminate

Finaliza la sesión interactiva.