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

资源：Document

文档会捕获要推荐或搜索的商品的所有原始元数据信息。

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.
}
字段
name

string

不可变。文档的完整资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}。

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
id

string

不可变。相应文档的标识符。

ID 应符合 RFC-1034 标准，长度限制为 128 个字符。
schemaId

string

位于同一数据存储区中的架构的标识符。
content

object (Content)

与此文档相关联的非结构化数据。内容只能设置，并且如果相应文档位于 CONTENT_REQUIRED 数据存储区下，则必须设置。
parentDocumentId

string

父文档的标识符。目前最多支持两级文档层次结构。

ID 应符合 RFC-1034 标准，长度上限为 63 个字符。
derivedStructData

object (Struct format)

仅限输出。此字段为 OUTPUT_ONLY。它包含原始输入文档中没有的派生数据。
aclInfo

object (AclInfo)

文档的访问权限控制信息。
indexTime

string (Timestamp format)

仅限输出。上次将相应文档编入索引的时间。如果设置了此字段，则可以在搜索结果中返回相应文档。

此字段为 OUTPUT_ONLY。如果未填充此字段，则表示相应文档从未编入索引。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
indexStatus

object (IndexStatus)

仅限输出。相应文档的索引状态。

  • 如果文档已成功编入索引，则系统会填充 indexTime 字段。
  • 否则，如果因错误而未将文档编入索引，则会填充 errorSamples 字段。
  • 否则，如果文档的索引编制正在进行中，则会填充 pendingMessage 字段。
联合字段 data。数据表示法。应提供 struct_data 或 json_data，否则会抛出 INVALID_ARGUMENT 错误。data 只能是下列其中一项：
structData

object (Struct format)

相应文档的结构化 JSON 数据。它应符合已注册的 Schema，否则会抛出 INVALID_ARGUMENT 错误。
jsonData

string

相应文档的 JSON 字符串表示形式。它应符合已注册的 Schema，否则会抛出 INVALID_ARGUMENT 错误。

方法

create

 创建 Document。

delete

 删除 Document。

get

 获取 Document。

import

 批量导入多个 Document。

list

 获取 Document 的列表。

patch

 更新 Document。

purge

 永久删除分支中的所有选定 Document。