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

资源:Branch

存储 Document 的数据分支。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "isDefault": boolean,
  "lastDocumentImportTime": string,
  "branchStats": {
    object (BranchStats)
  }
}
字段
name

string

不可变。分支的完整资源名称,例如 projects/*/locations/global/dataStores/dataStore/branches/branchId

displayName

string

仅限输出。要在界面中显示的易于用户理解的分支名称。

isDefault

boolean

仅限输出。指示相应分支是否已设置为其父数据存储区的默认分支。

lastDocumentImportTime

string (Timestamp format)

仅限输出。通过 DocumentService.ImportDocuments 进行的上次导入的时间戳。空值表示尚未向相应分支进行任何导入。

采用 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"

branchStats

object (BranchStats)

仅限输出。描述分支的统计信息。在 [BranchView.BASIC][] 视图中,此字段未填充。

BranchStats

描述分支的统计信息。

JSON 表示法
{
  "documentCounts": {
    string: string,
    ...
  }
}
字段
documentCounts

map (key: string, value: string (int64 format))

指定分支中的文档数量。

键是表示一组文档的群组,值是相应群组中的文档数量。注意:此映射中的键可能会随时间而变化。支持的键:['all']。

方法

batchGetDocumentsMetadata

获取 Document 的索引新鲜度元数据。

get

检索 Branch

list

列出指定父级 DataStore 下的所有 Branch