REST Resource: projects.locations.dataStores.sessions

Recurso: Sesión

Definición del protocolo de sesión externa.

Representación JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Campos
name

string

Inmutable. Nombre completo projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opcional. Nombre visible de la sesión.

Este campo se usa para identificar la sesión en la interfaz de usuario. De forma predeterminada, el nombre visible es el texto de la primera consulta de la sesión.
state

enum (State)

Estado de la sesión.
userPseudoId

string

Identificador único para monitorizar a los usuarios.
turns[]

object (Turn)

Turnos.
labels[]

string

Opcional. Etiquetas de la sesión. Se puede definir como filtro en ListSessionsRequest.
startTime

string (Timestamp format)

Solo de salida. La hora a la que se inició la sesión.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo de salida. Hora en la que finalizó la sesión.

Usa RFC 3339, donde la salida generada siempre se normaliza con Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otros desplazamientos distintos de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
isPinned

boolean

Opcional. Si la sesión está fijada, se mostrará en la parte superior de la lista de sesiones.

Métodos

create

 Crea una sesión.

delete

 Elimina una sesión.

get

 Obtiene una sesión.

list

 Muestra todas las sesiones por su DataStore principal.

patch

 Actualiza un recurso Session.