REST Resource: projects.locations.dataStores.sessions

Recurso: Session

Definição de proto de sessão externa.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Campos
name

string

Imutável. Nome totalmente qualificado projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Opcional. O nome de exibição da sessão.

Esse campo é usado para identificar a sessão na UI. Por padrão, o nome de exibição é o primeiro texto de consulta do turno na sessão.
state

enum (State)

O estado da sessão.
userPseudoId

string

Um identificador exclusivo para rastrear usuários.
turns[]

object (Turn)

Gira.
labels[]

string

Opcional. Os rótulos da sessão. Pode ser definido como filtro em "ListSessionsRequest".
startTime

string (Timestamp format)

Apenas saída. O horário em que a sessão começou.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
isPinned

boolean

Opcional. Se a sessão estiver fixada, ela vai aparecer na parte de cima da lista.

Métodos

create

 Cria uma sessão.

delete

 Exclui uma sessão.

get

 Recebe uma sessão.

list

 Lista todas as sessões pelo DataStore principal.

patch

 Atualiza uma sessão.