REST Resource: projects.locations.dataStores.sessions

Ressource : Session

Définition du proto de session externe.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean,
  "pendingAsyncAssistOperationId": string
}
Champs
name

string

Immuable. Nom complet projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Facultatif. Nom à afficher pour la session.

Ce champ permet d'identifier la session dans l'interface utilisateur. Par défaut, le nom à afficher correspond au texte de la première requête de la session.
state

enum (State)

État de la session.
userPseudoId

string

Identifiant unique permettant de suivre les utilisateurs.
turns[]

object (Turn)

Tours.
labels[]

string

Facultatif. Libellés de la session. Peut être défini comme filtre dans ListSessionsRequest.
startTime

string (Timestamp format)

Uniquement en sortie. Heure de début de la session.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Uniquement en sortie. Heure de fin de la session.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
isPinned

boolean

Facultatif. Indique si la session est épinglée. Les sessions épinglées s'affichent en haut de la liste des sessions.
pendingAsyncAssistOperationId

string

Uniquement en sortie. Nom de ressource complet d'une opération AsyncAssist en cours pour cette session, par exemple projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*. Défini au début de l'opération et effacé à la fin.

Méthodes

create

 Crée une session.

delete

 Supprime une session.

get

 Obtient une session.

list

 Liste toutes les sessions par leur parent DataStore.

patch

 Met à jour une session.