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

Ressource : Document

Le document capture toutes les informations brutes sur les 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)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
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, dont la longueur ne doit pas dépasser 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 et doit l'être que si ce document se trouve dans un data store CONTENT_REQUIRED.
parentDocumentId

string

Identifiant du document parent. Actuellement, la hiérarchie de documents est limitée à deux niveaux.

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 au document.
indexTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière indexation du document. Si ce champ est défini, le document peut être renvoyé dans les résultats de recherche.

Ce champ est OUTPUT_ONLY. 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é correctement, 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'indexation du document est en cours, le champ "pendingMessage" est renseigné.
Champ d'union data. Représentation des données. Vous devez fournir struct_data ou json_data. Sinon, une erreur INVALID_ARGUMENT est générée. data ne peut être qu'un des éléments suivants :
structData

object (Struct format)

Données JSON structurées pour le document. Il doit être conforme au Schema enregistré, sinon une erreur INVALID_ARGUMENT est générée.
jsonData

string

Représentation de la chaîne JSON du document. Il doit être conforme au Schema enregistré, sinon une erreur INVALID_ARGUMENT est générée.

Méthodes

create

 Crée un objet Document.

delete

 Supprime un Document.

get

 Récupère un Document.

import

 Importation groupée de plusieurs Document.

list

 Obtient une liste de Document.

patch

 Met à jour un Document.

purge

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