REST Resource: projects.locations.sessions

Recurso: sessão

Uma representação de uma sessão.

Representação 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

Obrigatório. O nome do recurso da sessão.
uuid

string

Apenas saída. Um UUID de sessão (identificador universal exclusivo). O serviço gera esse valor quando cria a sessão.
createTime

string (Timestamp format)

Apenas saída. O horário em que a sessão foi criada.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
runtimeInfo

object (RuntimeInfo)

Apenas saída. Informações de execução sobre a execução da sessão.
state

enum (State)

Apenas saída. Um estado da sessão.
stateMessage

string

Apenas saída. Detalhes do estado da sessão, como a descrição da falha se o estado for FAILED.
stateTime

string (Timestamp format)

Apenas saída. O horário em que a sessão entrou no estado atual.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
creator

string

Apenas saída. O endereço de e-mail do usuário que criou a sessão.
labels

map (key: string, value: string)

Opcional. Os rótulos a serem associados à sessão. As chaves de identificador precisam conter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Os valores do marcador podem estar vazios, mas, se estiverem presentes, precisam conter de 1 a 63 caracteres e estar em conformidade com o RFC 1035. Não é possível associar mais de 32 rótulos a uma sessão.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
runtimeConfig

object (RuntimeConfig)

Opcional. Configuração do ambiente de execução para a execução da sessão.
environmentConfig

object (EnvironmentConfig)

Opcional. Configuração do ambiente para a execução da sessão.
user

string

Opcional. O endereço de e-mail do usuário proprietário da sessão.
stateHistory[]

object (SessionStateHistory)

Apenas saída. Informações de estado histórico da sessão.
sessionTemplate

string

Opcional. O modelo de sessão usado pela sessão.

Somente os nomes dos recursos, incluindo o ID e o local do projeto, são válidos.

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

O modelo precisa estar no mesmo projeto e região do Dataproc da sessão.
Campo de união session_config. A configuração da sessão. session_config pode ser apenas de um dos tipos a seguir:
jupyterSession

object (JupyterConfig)

Opcional. Configuração da sessão do Jupyter.
sparkConnectSession

object (SparkConnectConfig)

Opcional. Configuração da sessão do Spark Connect.

Estado

O estado da sessão.

Enums
STATE_UNSPECIFIED O estado da sessão é desconhecido.
CREATING A sessão é criada antes da execução.
ACTIVE A sessão está em execução.
TERMINATING A sessão está sendo encerrada.
TERMINATED A sessão é encerrada.
FAILED A sessão não está mais em execução devido a um erro.

SessionStateHistory

Informações de estado histórico.

Representação JSON 
{
  "state": enum (State),
  "stateMessage": string,
  "stateStartTime": string
}
Campos
state

enum (State)

Apenas saída. O estado da sessão neste ponto do histórico.
stateMessage

string

Apenas saída. Detalhes sobre o estado nesse ponto do histórico da sessão.
stateStartTime

string (Timestamp format)

Apenas saída. O horário em que a sessão entrou no estado histórico.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Métodos

create

 Crie uma sessão interativa de maneira assíncrona.

delete

 Exclui o recurso de sessão interativa.

get

 Busca a representação de recurso de uma sessão interativa.

list

 Lista sessões interativas.

terminate

 Encerra a sessão interativa.