REST Resource: projects.locations.dataStores.branches.documents

Ressource: Dokument

In einem Dokument werden alle Rohmetadateninformationen von Elementen erfasst, die empfohlen oder gesucht werden sollen.

JSON-Darstellung 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
Felder
name

string

Nicht veränderbar. Der vollständige Ressourcenname des Dokuments. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Dieses Feld muss einen UTF-8-codierten String mit maximal 1.024 Zeichen enthalten.
id

string

Nicht veränderbar. Die Kennung des Dokuments.

Die ID sollte dem RFC-1034-Standard entsprechen und darf maximal 128 Zeichen lang sein.
schemaId

string

Die Kennung des Schemas, das sich im selben Datenspeicher befindet.
content

object (Content)

Die mit diesem Dokument verknüpften unstrukturierten Daten. Inhalte können nur festgelegt werden und müssen festgelegt werden, wenn sich dieses Dokument in einem CONTENT_REQUIRED-Datenspeicher befindet.
parentDocumentId

string

Die Kennung des übergeordneten Dokuments. Derzeit werden nur Dokumenthierarchien mit maximal zwei Ebenen unterstützt.

Die ID sollte dem RFC-1034-Standard entsprechen und darf maximal 63 Zeichen lang sein.
derivedStructData

object (Struct format)

Nur Ausgabe. Dieses Feld ist OUTPUT_ONLY. Es enthält abgeleitete Daten, die nicht im ursprünglichen Eingabedokument enthalten sind.
aclInfo

object (AclInfo)

Informationen zur Zugriffssteuerung für das Dokument.
indexTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt der letzten Indexierung des Dokuments. Wenn dieses Feld festgelegt ist, kann das Dokument in den Suchergebnissen zurückgegeben werden.

Dieses Feld ist OUTPUT_ONLY. Wenn in diesem Feld nichts steht, wurde das Dokument noch nie indexiert.

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".
indexStatus

object (IndexStatus)

Nur Ausgabe. Der Indexstatus des Dokuments.

  • Wenn das Dokument erfolgreich indexiert wurde, ist das Feld „indexTime“ ausgefüllt.
  • Wenn das Dokument aufgrund von Fehlern nicht indexiert wurde, ist das Feld „errorSamples“ ausgefüllt.
  • Wenn das Dokument gerade indexiert wird, ist das Feld „pendingMessage“ ausgefüllt.
Union-Feld data. Für die Datendarstellung. Es muss entweder struct_data oder json_data angegeben werden. Andernfalls wird der Fehler INVALID_ARGUMENT ausgegeben. Für data ist nur einer der folgenden Werte zulässig:
structData

object (Struct format)

Die strukturierten JSON-Daten des Dokuments. Muss dem registrierten Schema entsprechen, andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.
jsonData

string

Die JSON-String-Darstellung des Dokuments. Muss dem registrierten Schema entsprechen, andernfalls wird ein INVALID_ARGUMENT-Fehler ausgegeben.

Methoden

create

 Erstellt ein Document.

delete

 Löscht ein Document.

get

 Ruft ein Document ab.

import

 Bulk-Import mehrerer Documents.

list

 Ruft eine Liste der Documents ab.

patch

 Aktualisiert ein Document.

purge

 Löscht alle ausgewählten Documents in einem Zweig endgültig.