此页面由 Cloud Translation API 翻译。
Switch to English

软件包google.firestore.admin.v1beta1

指数

Firestore管理员

Cloud Firestore Admin 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

有关更多信息,请参阅身份验证概述

CreateIndexRequest

FirestoreAdmin.CreateIndex的请求。

领域
parent

string

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

index

Index

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

DeleteIndexRequest

FirestoreAdmin.DeleteIndex的请求。

领域
name

string

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

ExportDocuments元数据

ExportDocuments操作的元数据。

领域
start_time

Timestamp

手术开始的时间。

end_time

Timestamp

操作成功完成或失败的时间。如果该操作仍处于活动状态,则取消设置。

operation_state

OperationState

导出操作的状态。

progress_documents

Progress

估计处理的文档数。

progress_bytes

Progress

对已处理字节数的估计。

collection_ids[]

string

正在导出哪些集合ID。

output_uri_prefix

string

将实体导出到的位置。

ExportDocumentsRequest

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是存储桶(没有命名空间路径),则会根据开始时间生成前缀。

ExportDocumentsResponse

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

领域
output_uri_prefix

string

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

GetIndexRequest

FirestoreAdmin.GetIndex的请求。

领域
name

string

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

ImportDocuments元数据

ImportDocuments操作的元数据。

领域
start_time

Timestamp

手术开始的时间。

end_time

Timestamp

操作成功结束的时间,否则成功。如果该操作仍处于活动状态,则取消设置。

operation_state

OperationState

导入操作的状态。

progress_documents

Progress

估计处理的文档数。

progress_bytes

Progress

对已处理字节数的估计。

collection_ids[]

string

正在导入哪些集合标识。

input_uri_prefix

string

导入文件的位置。

ImportDocumentsRequest

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__可以单独使用,也可以在路径__name__使用。 __type__只能在路径末尾使用。

mode

Mode

字段的模式。

模式

该模式确定如何索引字段。

枚举
MODE_UNSPECIFIED 未指定模式。
ASCENDING 对该字段的值进行索引,以支持升序排序,还可以通过<,>,<=,> =和=查询。
DESCENDING 对该字段的值进行索引,以支持降序排序,还可以通过<,>,<=,> =和=查询。
ARRAY_CONTAINS 对该字段的数组值进行索引,以支持使用ARRAY_CONTAINS查询的成员资格。

IndexOperation元数据

索引操作的元数据。此元数据填充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调用启动。

ListIndexesRequest

FirestoreAdmin.ListIndexes的请求。

领域
parent

string

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

filter

string

page_size

int32

标准列表页面大小。

page_token

string

标准列表页面令牌。

ListIndexesResponse

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

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