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

Risorsa: Documento

Il documento acquisisce tutte le informazioni sui metadati non elaborati degli elementi da consigliare o cercare.

Rappresentazione 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.
}
Campi
name

string

Immutabile. Il nome completo della risorsa del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Questo campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 1024 caratteri.
id

string

Immutabile. L'identificatore del documento.

L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 128 caratteri.
schemaId

string

L'identificatore dello schema che si trova nello stesso datastore.
content

object (Content)

I dati non strutturati collegati a questo documento. Il contenuto può essere impostato solo se questo documento si trova in un datastore CONTENT_REQUIRED.
parentDocumentId

string

L'identificatore del documento principale. Al momento supporta al massimo una gerarchia di documenti a due livelli.

L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri.
derivedStructData

object (Struct format)

Solo output. Questo campo è OUTPUT_ONLY. Contiene dati derivati che non sono presenti nel documento di input originale.
aclInfo

object (AclInfo)

Informazioni sul controllo dell'accesso per il documento.
indexTime

string (Timestamp format)

Solo output. L'ora dell'ultima indicizzazione del documento.

Se questo campo è compilato, significa che il documento è stato indicizzato. Sebbene i documenti diventino in genere ricercabili entro pochi secondi dall'indicizzazione, a volte possono essere necessarie fino a qualche ora.

Se questo campo non è compilato, significa che il documento non è mai stato indicizzato.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Solo output. Lo stato di indicizzazione del documento.

  • Se il documento viene indicizzato correttamente, il campo indexTime viene compilato.
  • In caso contrario, se il documento non viene indicizzato a causa di errori, il campo errorSamples viene compilato.
  • In caso contrario, se l'indice del documento è in corso, il campo pendingMessage viene compilato.
Campo unione data. Rappresentazione dei dati. È necessario fornire struct_data o json_data, altrimenti viene generato un errore INVALID_ARGUMENT. data può essere solo uno dei seguenti:
structData

object (Struct format)

I dati JSON strutturati per il documento. Deve essere conforme allo Schema registrato, altrimenti viene generato un errore INVALID_ARGUMENT.
jsonData

string

La rappresentazione della stringa JSON del documento. Deve essere conforme allo Schema registrato, altrimenti viene generato un errore INVALID_ARGUMENT.

Metodi

create

 Crea un Document.

delete

 Elimina un Document.

get

 Ottiene un Document.

import

 Importazione collettiva di più Document.

list

 Ottiene un elenco di Document.

patch

 Aggiorna un Document.

purge

 Elimina definitivamente tutti i Document selezionati in un ramo.