REST Resource: projects.locations.dataStores.sessions

Risorsa: Sessione

Definizione del proto della sessione esterna.

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

string

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

string

Facoltativo. Il nome visualizzato della sessione.

Questo campo viene utilizzato per identificare la sessione nell'interfaccia utente. Per impostazione predefinita, il nome visualizzato è il testo della query del primo turno nella sessione.
state

enum (State)

Lo stato della sessione.
userPseudoId

string

Un identificatore univoco per il monitoraggio degli utenti.
turns[]

object (Turn)

Turni.
labels[]

string

Facoltativo. Le etichette per la sessione. Può essere impostato come filtro in ListSessionsRequest.
startTime

string (Timestamp format)

Solo output. L'ora di inizio della sessione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo output. L'ora di fine della sessione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
isPinned

boolean

Facoltativo. Indica se la sessione è bloccata. Le sessioni bloccate vengono visualizzate nella parte superiore dell'elenco delle sessioni.

Metodi

create

 Crea una sessione.

delete

 Elimina una sessione.

get

 Recupera una sessione.

list

 Elenca tutte le sessioni in base al relativo DataStore principale.

patch

 Aggiorna una sessione.