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

Resource: Document

Dokumen mencatat semua informasi metadata mentah item yang akan direkomendasikan atau ditelusuri.

Representasi 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.
}
Kolom
name

string

Tidak dapat diubah. Nama lengkap resource dokumen. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
id

string

Tidak dapat diubah. ID dokumen.

ID harus sesuai dengan standar RFC-1034 dengan batas panjang 128 karakter.
schemaId

string

ID skema yang berada di penyimpanan data yang sama.
content

object (Content)

Data tidak terstruktur yang ditautkan ke dokumen ini. Konten hanya dapat disetel dan harus disetel jika dokumen ini berada di penyimpanan data CONTENT_REQUIRED.
parentDocumentId

string

ID dokumen induk. Saat ini mendukung hierarki dokumen paling banyak dua tingkat.

ID harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter.
derivedStructData

object (Struct format)

Hanya output. Kolom ini bersifat OUTPUT_ONLY. Dokumen ini berisi data turunan yang tidak ada dalam dokumen input asli.
aclInfo

object (AclInfo)

Informasi kontrol akses untuk dokumen.
indexTime

string (Timestamp format)

Hanya output. Waktu saat dokumen terakhir diindeks.

Jika kolom ini terisi, berarti dokumen telah diindeks. Meskipun dokumen biasanya dapat dicari dalam beberapa detik setelah pengindeksan, terkadang hal ini dapat memerlukan waktu hingga beberapa jam.

Jika kolom ini tidak diisi, artinya dokumen belum pernah diindeks.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Hanya output. Status indeks dokumen.

  • Jika dokumen berhasil diindeks, kolom indexTime akan diisi.
  • Jika tidak, jika dokumen tidak diindeks karena error, kolom errorSamples akan diisi.
  • Jika tidak, jika indeks dokumen sedang berlangsung, kolom pendingMessage akan diisi.
Kolom union data. Representasi data. Salah satu dari struct_data atau json_data harus diberikan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. data hanya dapat berupa salah satu dari hal berikut:
structData

object (Struct format)

Data JSON terstruktur untuk dokumen. Harus sesuai dengan Schema yang terdaftar atau error INVALID_ARGUMENT akan ditampilkan.
jsonData

string

Representasi string JSON dokumen. Harus sesuai dengan Schema yang terdaftar atau error INVALID_ARGUMENT akan ditampilkan.

Metode

create

 Membuat Document.

delete

 Menghapus Document.

get

 Mendapatkan Document.

import

 Impor massal beberapa Document.

list

 Mendapatkan daftar Document.

patch

 Memperbarui Document.

purge

 Menghapus semua Document yang dipilih secara permanen di cabang.