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

Ressource : Document

Un document capture toutes les informations brutes de métadonnées des éléments à recommander ou à rechercher.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "structData": {
    object
  },
  "jsonData": string
  // End of mutually exclusive fields.
}
Champs
name

string

Immuable. Nom complet de la ressource du document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Ce champ doit être une chaîne encodée au format UTF-8 d'une longueur maximale de 1 024 caractères.
id

string

Immuable. Identifiant du document.

L'ID doit être conforme à la norme RFC-1034 et ne pas dépasser 128 caractères.
schemaId

string

Identifiant du schéma situé dans le même data store.
content

object (Content)

Données non structurées associées à ce document. Le contenu ne peut être défini que s'il s'agit d'un data store CONTENT_REQUIRED.
parentDocumentId

string

Identifiant du document parent. Actuellement, la hiérarchie de documents ne peut comporter que deux niveaux au maximum.

L'ID doit être conforme à la norme RFC-1034 et ne pas dépasser 63 caractères.
derivedStructData

object (Struct format)

Uniquement en sortie. Ce champ est OUTPUT_ONLY. Il contient des données dérivées qui ne figurent pas dans le document d'entrée d'origine.
aclInfo

object (AclInfo)

Informations sur le contrôle des accès pour le document.
indexTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière indexation du document.

Si ce champ est renseigné, cela signifie que le document a été indexé. Bien que les documents deviennent généralement consultables quelques secondes après l'indexation, cela peut parfois prendre jusqu'à quelques heures.

Si ce champ n'est pas renseigné, cela signifie que le document n'a jamais été indexé.

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

object (IndexStatus)

Uniquement en sortie. État d'indexation du document.

  • Si le document est indexé, le champ indexTime est renseigné.
  • Sinon, si le document n'est pas indexé en raison d'erreurs, le champ errorSamples est renseigné.
  • Sinon, si l'index du document est en cours, le champ pendingMessage est renseigné.
Représentation des données. Vous devez fournir struct_data ou json_data. Sinon, une erreur INVALID_ARGUMENT est générée. Voici une liste de champs mutuellement exclusifs. Au maximum, un seul de ces champs sera défini dans une réponse :
structData

object (Struct format)

Données JSON structurées pour le document. Elles doivent être conformes au Schema enregistré. Sinon, une erreur INVALID_ARGUMENT est générée.
jsonData

string

Représentation du document sous forme de chaîne JSON. Elle doit être conforme au Schema enregistré. Sinon, une erreur INVALID_ARGUMENT est générée.
Fin des champs mutuellement exclusifs.

Méthodes

create

 Crée un Document.

delete

 Supprime un Document.

get

 Récupère un Document.

import

 Importation par lots de plusieurs Documents.

list

 Obtient une liste de Documents.

patch

 Met à jour un Document.

purge

 Supprime définitivement tous les Documents sélectionnés dans une branche.