Package google.firestore.admin.v1beta1

指数

Firestore管理员

Cloud Firestore 管理 API。

此 API 为 Cloud Firestore 提供多种管理服务。

概念

项目、数据库、命名空间、集合和文档按照 Google Cloud Firestore API 中的定义使用。

操作:操作表示在后台执行的工作。

服务

指数

索引服务管理 Cloud Firestore 索引。

索引创建是异步执行的。为每个此类异步操作创建一个操作资源。操作的状态(包括遇到的任何错误)可以通过操作资源查询。

元数据

提供有关 Cloud Firestore 中数据的元数据和统计信息。作为此 API 的一部分提供的数据可能已过时。

手术

操作集合提供对指定项目执行的操作的记录(包括任何正在进行的操作)。操作不是直接创建的,而是通过调用其他集合或资源来创建的。

尚未完成的操作可能会被取消。取消请求是异步的,并且在发出取消请求后操作可能会继续运行一段时间。

已完成的操作可以被删除,以便它不再作为操作集合的一部分列出。

操作由服务FirestoreAdmin创建,但通过服务google.longrunning.Operations访问。

创建索引

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

创建指定的索引。新创建的索引的初始状态是CREATING 。返回的google.longrunning.Operation完成后,状态将为READY 。如果索引已存在,则调用将返回ALREADY_EXISTS状态。

在创建过程中,该过程可能会导致错误,在这种情况下索引将移至ERROR状态。可以通过修复导致错误的数据、使用delete删除索引,然后使用create重新创建索引来恢复该过程。

无法创建单个字段的索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

删除索引

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

删除索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

出口单据

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

将全部或部分文档的副本从 Google Cloud Firestore 导出到另一个存储系统,例如 Google Cloud Storage。最近对文档的更新可能不会反映在导出中。导出在后台进行,可以通过创建的操作资源监视和管理其进度。导出的输出只能在相关操作完成后才能使用。如果导出操作在完成之前取消,则可能会在 Google Cloud Storage 中留下部分数据。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

获取索引

rpc GetIndex( GetIndexRequest ) returns ( Index )

获取索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

进口文件

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

将文档导入 Google Cloud Firestore。现有的同名文档将被覆盖。导入在后台进行,可以通过创建的操作资源监视和管理其进度。如果取消 ImportDocuments 操作,则数据的子集可能已导入到 Cloud Firestore。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

列表索引

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

列出与指定过滤器匹配的索引。

授权范围

需要以下 OAuth 范围之一:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

有关详细信息,请参阅身份验证概述

创建索引请求

FirestoreAdmin.CreateIndex的请求。

领域
parent

string

该索引将应用到的数据库的名称。例如: projects/{project_id}/databases/{database_id}

index

Index

要创建的索引。名称和状态字段仅输出,将被忽略。某些单字段索引无法创建或删除。

删除索引请求

FirestoreAdmin.DeleteIndex的请求。

领域
name

string

索引名称。例如: projects/{project_id}/databases/{database_id}/indexes/{index_id}

导出文档元数据

ExportDocuments 操作的元数据。

领域
start_time

Timestamp

手术开始的时间。

end_time

Timestamp

操作结束的时间,无论成功还是失败。如果操作仍处于活动状态,请取消设置。

operation_state

OperationState

出口操作的状态。

progress_documents

Progress

已处理文档数量的估计。

progress_bytes

Progress

已处理字节数的估计值。

collection_ids[]

string

正在导出哪些集合 ID。

output_uri_prefix

string

实体导出到的位置。

出口文件请求

FirestoreAdmin.ExportDocuments的请求。

领域
name

string

要导出的数据库。应采用以下形式: projects/{project_id}/databases/{database_id}

collection_ids[]

string

要导出哪个集合 ID。未指定是指所有集合。

output_uri_prefix

string

输出 URI。目前仅支持以下形式的 Google Cloud Storage URI: gs://BUCKET_NAME[/NAMESPACE_PATH] ,其中BUCKET_NAME是 Google Cloud Storage 存储桶的名称, NAMESPACE_PATH是可选的 Google Cloud Storage 命名空间路径。选择名称时,请务必考虑 Google Cloud Storage 命名指南:https: //cloud.google.com/storage/docs/naming 。如果 URI 是一个存储桶(没有命名空间路径),则会根据开始时间生成前缀。

出口单据响应

google.longrunning.Operation响应字段中返回。

领域
output_uri_prefix

string

输出文件的位置。这可用于在操作成功完成后开始导入 Cloud Firestore(此项目或另一个项目)。

获取索引请求

FirestoreAdmin.GetIndex的请求。

领域
name

string

索引的名称。例如: projects/{project_id}/databases/{database_id}/indexes/{index_id}

导入文件元数据

ImportDocuments 操作的元数据。

领域
start_time

Timestamp

手术开始的时间。

end_time

Timestamp

操作结束的时间,无论成功还是失败。如果操作仍处于活动状态,请取消设置。

operation_state

OperationState

导入操作的状态。

progress_documents

Progress

已处理文档数量的估计。

progress_bytes

Progress

已处理字节数的估计值。

collection_ids[]

string

正在导入哪些集合 ID。

input_uri_prefix

string

正在导入的文档的位置。

进口文件请求

FirestoreAdmin.ImportDocuments的请求。

领域
name

string

要导入的数据库。应采用以下形式: projects/{project_id}/databases/{database_id}

collection_ids[]

string

要导入哪个集合 ID。未指定表示导入中包含的所有集合。

input_uri_prefix

string

导出文件的位置。这必须与已成功完成导出的 ExportDocumentsResponse 的 output_uri_prefix 匹配。请参阅: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix

指数

索引定义。

领域
name

string

索引的资源名称。仅输出。

collection_id

string

该索引适用的集合 ID。必需的。

fields[]

IndexField

要索引的字段。

state

State

索引的状态。仅输出。

状态

索引的状态。在索引创建过程中,索引将处于CREATING状态。如果索引创建成功,则会转入READY状态。如果无法创建索引,则会转换为ERROR状态。

枚举
STATE_UNSPECIFIED状态未指定。
CREATING正在创建索引。该索引有一个活跃的长期运行操作。写入文档时索引会更新。可能存在一些索引数据。
READY该索引已准备好可供使用。写入文档时索引会更新。该索引完全由它所适用的所有存储文档填充。
ERROR正在创建索引,但出了点问题。该索引没有活动的长时间运行操作,并且最近完成的长时间运行操作失败。写入文档时索引不会更新。可能存在一些索引数据。

索引字段

索引的一个字段。

领域
field_path

string

田野的路径。必须匹配 [google.firestore.v1beta1.Document.fields][fields] 描述的字段路径规范。特殊字段路径__name__可以单独使用,也可以在路径末尾使用。 __type__只能在路径末尾使用。

mode

Mode

场的模式。

模式

模式决定字段的索引方式。

枚举
MODE_UNSPECIFIED模式未指定。
ASCENDING该字段的值被索引,以支持升序排序,也支持按 <、>、<=、>= 和 = 查询。
DESCENDING该字段的值被索引,以支持降序排序,也支持按 <、>、<=、>= 和 = 查询。
ARRAY_CONTAINS该字段的数组值已建立索引,以便支持使用 ARRAY_CONTAINS 查询的成员资格。

索引操作元数据

索引操作的元数据。此元数据填充google.longrunning.Operation的元数据字段。

领域
start_time

Timestamp

手术开始的时间。

end_time

Timestamp

操作结束的时间,无论成功还是失败。如果操作仍处于活动状态,请取消设置。

index

string

此操作所作用的索引资源。例如: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

索引操作的类型。

cancelled

bool

如果google.longrunning.Operation被取消,则为 True。如果正在进行取消,canceled 将为 true,但google.longrunning.Operation.done将为 false。

document_progress

Progress

现有操作的进度,以文件数量衡量。

操作类型

索引操作的类型。

枚举
OPERATION_TYPE_UNSPECIFIED未指定。绝不由服务器设置。
CREATING_INDEX该操作正在创建索引。由CreateIndex调用启动。

列出索引请求

FirestoreAdmin.ListIndexes的请求。

领域
parent

string

数据库名称。例如: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

标准列表页面大小。

page_token

string

标准列表页面令牌。

列表索引响应

FirestoreAdmin.ListIndexes的响应。

领域
indexes[]

Index

索引。

next_page_token

string

标准列表下一页标记。

位置元数据

该类型没有字段。

google.cloud.location.Location.metadata的元数据消息。

操作状态

正在进行的操作的各种可能状态。

枚举
STATE_UNSPECIFIED未指定。
INITIALIZING正在准备处理请求。
PROCESSING正在积极处理请求。
CANCELLING用户对操作调用 google.longrunning.Operations.CancelOperation 后,请求正在取消。
FINALIZING请求已处理并处于最终确定阶段。
SUCCESSFUL请求已成功完成。
FAILED请求已完成处理,但遇到错误。
CANCELLED用户调用 google.longrunning.Operations.CancelOperation 后,请求已完成取消。

进步

衡量特定指标的进度。

领域
work_completed

int64

已完成工作量的估计。请注意,这可能大于work_estimated

work_estimated

int64

需要执行多少工作的估计。如果工作估算不可用,则为零。随着工作的进展可能会发生变化。