REST Resource: projects.locations.dataStores.sessions

Ressource: Sitzung

Externe Sitzung – Proto-Definition.

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

string

Nicht veränderbar. Vollständig qualifizierter Name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Optional. Der Anzeigename der Sitzung.

Mit diesem Feld wird die Sitzung in der Benutzeroberfläche identifiziert. Standardmäßig ist der Anzeigename der Text der ersten Anfrage in der Sitzung.
state

enum (State)

Der Status der Sitzung.
userPseudoId

string

Eine eindeutige Kennung für das Tracking von Nutzern.
turns[]

object (Turn)

Runden.
labels[]

string

Optional. Die Labels für die Sitzung. Kann als Filter in ListSessionsRequest festgelegt werden.
startTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung begonnen hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Nur Ausgabe. Die Uhrzeit, zu der die Sitzung beendet wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
isPinned

boolean

Optional. Ob die Sitzung angepinnt ist. Angepinnte Sitzungen werden oben in der Sitzungsliste angezeigt.

Methoden

create

 Erstellt eine Sitzung.

delete

 Löscht eine Sitzung.

get

 Ruft eine Sitzung ab.

list

 Listet alle Sitzungen nach dem übergeordneten DataStore auf.

patch

 Aktualisiert eine Sitzung.