指数
FirestoreAdmin
(界面)-
Backup
(消息) -
Backup.State
(枚举) -
BackupSchedule
(消息) -
CreateBackupScheduleRequest
(消息) -
CreateDatabaseMetadata
(消息) -
CreateDatabaseRequest
(消息) -
CreateIndexRequest
(消息) -
DailyRecurrence
(消息) -
Database
(消息) -
Database.AppEngineIntegrationMode
(枚举) -
Database.ConcurrencyMode
(枚举) -
Database.DatabaseType
(枚举) -
Database.DeleteProtectionState
(枚举) -
Database.PointInTimeRecoveryEnablement
(枚举) -
DeleteBackupRequest
(消息) -
DeleteBackupScheduleRequest
(消息) -
DeleteDatabaseMetadata
(消息) -
DeleteDatabaseRequest
(消息) -
DeleteIndexRequest
(消息) -
ExportDocumentsMetadata
(消息) -
ExportDocumentsRequest
(消息) -
ExportDocumentsResponse
(消息) -
Field
(消息) -
Field.IndexConfig
(消息) -
Field.TtlConfig
(消息) -
Field.TtlConfig.State
(枚举) -
FieldOperationMetadata
(消息) -
FieldOperationMetadata.IndexConfigDelta
(消息) -
FieldOperationMetadata.IndexConfigDelta.ChangeType
(枚举) -
FieldOperationMetadata.TtlConfigDelta
(消息) -
FieldOperationMetadata.TtlConfigDelta.ChangeType
(枚举) -
GetBackupRequest
(消息) -
GetBackupScheduleRequest
(消息) -
GetDatabaseRequest
(消息) -
GetFieldRequest
(消息) -
GetIndexRequest
(消息) -
ImportDocumentsMetadata
(消息) -
ImportDocumentsRequest
(消息) -
Index
(消息) -
Index.ApiScope
(枚举) -
Index.IndexField
(消息) -
Index.IndexField.ArrayConfig
(枚举) -
Index.IndexField.Order
(枚举) -
Index.QueryScope
(枚举) -
Index.State
(枚举) -
IndexOperationMetadata
(消息) -
ListBackupSchedulesRequest
(消息) -
ListBackupSchedulesResponse
(消息) -
ListBackupsRequest
(消息) -
ListBackupsResponse
(消息) -
ListDatabasesRequest
(消息) -
ListDatabasesResponse
(消息) -
ListFieldsRequest
(消息) -
ListFieldsResponse
(消息) -
ListIndexesRequest
(消息) -
ListIndexesResponse
(消息) -
LocationMetadata
(消息) -
OperationState
(枚举) -
Progress
(消息) -
RestoreDatabaseMetadata
(消息) -
RestoreDatabaseRequest
(消息) -
UpdateBackupScheduleRequest
(消息) -
UpdateDatabaseMetadata
(消息) -
UpdateDatabaseRequest
(消息) -
UpdateFieldRequest
(消息) -
WeeklyRecurrence
(消息)
Firestore管理员
Cloud Firestore 管理 API。
此 API 为 Cloud Firestore 提供多种管理服务。
项目、数据库、命名空间、集合、集合组和文档按照 Google Cloud Firestore API 中的定义使用。
操作:操作表示在后台执行的工作。
索引服务管理 Cloud Firestore 索引。
索引创建是异步执行的。为每个此类异步操作创建一个操作资源。操作的状态(包括遇到的任何错误)可以通过操作资源查询。
操作集合提供对指定项目执行的操作的记录(包括任何正在进行的操作)。操作不是直接创建的,而是通过调用其他集合或资源来创建的。
已完成的操作可以被删除,以便它不再作为操作集合的一部分列出。 30 天后操作将被垃圾收集。默认情况下,ListOperations 将仅返回正在进行和失败的操作。要列出已完成的操作,请发出带有过滤器done: true
ListOperations 请求。
操作由服务FirestoreAdmin
创建,但通过服务google.longrunning.Operations
访问。
创建备份计划 |
---|
在数据库上创建备份计划。一个数据库最多可以配置两个备份计划,一个是每日备份计划,保留时间最长为 7 天,另一个是每周备份计划,保留时间最长为 14 周。
|
创建数据库 |
---|
创建数据库。
|
创建索引 |
---|
创建复合索引。这会返回一个
|
删除备份 |
---|
删除备份。
|
删除备份计划 |
---|
删除备份计划。
|
删除数据库 |
---|
删除数据库。
|
删除索引 |
---|
删除复合索引。
|
出口单据 |
---|
将全部或部分文档的副本从 Google Cloud Firestore 导出到另一个存储系统,例如 Google Cloud Storage。最近对文档的更新可能不会反映在导出中。导出在后台进行,可以通过创建的操作资源监视和管理其进度。导出的输出只能在相关操作完成后才能使用。如果导出操作在完成之前取消,则可能会在 Google Cloud Storage 中留下部分数据。 有关导出行为和输出格式的更多详细信息,请参阅: https://cloud.google.com/firestore/docs/manage-data/export-import
|
重新站起来 |
---|
获取有关备份的信息。
|
获取备份计划 |
---|
获取有关备份计划的信息。
|
获取数据库 |
---|
获取有关数据库的信息。
|
获取字段 |
---|
获取字段的元数据和配置。
|
获取索引 |
---|
获取复合索引。
|
进口文件 |
---|
将文档导入 Google Cloud Firestore。现有的同名文档将被覆盖。导入在后台进行,可以通过创建的操作资源监视和管理其进度。如果取消 ImportDocuments 操作,则数据的子集可能已导入到 Cloud Firestore。
|
列出备份计划 |
---|
列出备份计划。
|
备份列表 |
---|
列出所有备份。
|
列出数据库 |
---|
列出项目中的所有数据库。
|
列表字段 |
---|
列出该数据库的字段配置和元数据。 目前,
|
列表索引 |
---|
列出复合索引。
|
恢复数据库 |
---|
通过从现有备份恢复来创建新数据库。 新数据库必须与现有备份位于同一云区域或多区域位置。其行为类似于 [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase],只不过不是创建新的空数据库,而是使用数据库类型、索引配置和现有备份中的文档创建新数据库。
|
更新备份计划 |
---|
更新备份计划。
|
更新数据库 |
---|
更新数据库。
|
更新字段 |
---|
更新字段配置。目前,字段更新仅适用于单字段索引配置。但是,对 此调用返回 要配置数据库的默认字段设置,请使用带有资源名称的特殊
|
备份
Cloud Firestore 数据库的备份。
备份包含给定数据库在特定时间点的所有文档和索引配置。
领域 | |
---|---|
name | 仅输出。备份的唯一资源名称。 格式为 |
database | 仅输出。备份所在的 Firestore 数据库的名称。 格式为 |
database_uid | 仅输出。系统为备份所在的 Firestore 数据库生成的 UUID4。 |
snapshot_time | 仅输出。此时备份包含数据库的外部一致副本。 |
expire_time | 仅输出。此备份到期的时间戳。 |
state | 仅输出。备份的当前状态。 |
状态
指示备份的当前状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定。 |
CREATING | 仍在创建挂起的备份。在此状态下,对备份的操作将被拒绝。 |
READY | 备份已完成并可以使用。 |
NOT_AVAILABLE | 备份目前不可用。 |
备份计划
Cloud Firestore 数据库的备份计划。
该资源归其正在备份的数据库所有,并与数据库一起删除。但实际的备份并非如此。
领域 | |
---|---|
name | 仅输出。给定项目的所有位置和数据库的唯一备份计划标识符。 这将被自动分配。 格式为 |
create_time | 仅输出。创建此备份计划并自此生效的时间戳。 在此时间之前不会为此计划创建任何备份。 |
update_time | 仅输出。最近更新此备份计划的时间戳。首次创建备份计划时,这与 create_time 相同。 |
retention | 与备份的创建时间相比,在未来的什么相对时间,应该删除备份,例如保留备份7天。 |
联盟场recurrence 。表示何时进行备份的 oneof 字段。 recurrence 只能是以下情况之一: | |
daily_recurrence | 对于每天在指定时间运行的计划。 |
weekly_recurrence | 对于每周在特定日期和时间运行的计划。 |
创建备份计划请求
领域 | |
---|---|
parent | 必需的。父数据库。 格式化 |
backup_schedule | 必需的。要创建的备份计划。 |
创建数据库元数据
该类型没有字段。
与创建数据库操作相关的元数据。
创建数据库请求
领域 | |
---|---|
parent | 必需的。表单的父级名称 |
database | 必需的。要创建的数据库。 |
database_id | 必需的。用于数据库的 ID,它将成为数据库资源名称的最终组成部分。 该值应为 4-63 个字符。有效字符为 /[az][0-9]-/,第一个字符为字母,最后一个字符为字母或数字。不得类似于 UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。 “(默认)”数据库 ID 也有效。 |
创建索引请求
领域 | |
---|---|
parent | 必需的。 |
index | 必需的。要创建的复合索引。 |
每日重复
该类型没有字段。
表示每天在特定时间运行的重复计划。
时区为 UTC。
数据库
Cloud Firestore 数据库。
领域 | |
---|---|
name | 数据库的资源名称。格式: |
uid | 仅输出。系统为此数据库生成的 UUID4。 |
create_time | 仅输出。创建此数据库的时间戳。 2016 年之前创建的数据库不会填充 create_time。 |
update_time | 仅输出。该数据库最近更新的时间戳。请注意,这仅包括对数据库资源的更新,而不包括数据库包含的数据。 |
location_id | 数据库的位置。 https://cloud.google.com/firestore/docs/locations列出了可用位置。 |
type | 数据库的类型。有关如何选择的信息,请参阅https://cloud.google.com/datastore/docs/firestore-or-datastore 。 |
concurrency_mode | 用于此数据库的并发控制模式。 |
version_retention_period | 仅输出。过去版本的数据保留在数据库中的时间段。 任何 如果启用 PITR 功能,保留期为 7 天。否则,保留期限为 1 小时。 |
earliest_version_time | 仅输出。可以从数据库读取旧版本数据的最早时间戳。请参阅上面的[version_retention_period];该字段填充有 该值会不断更新,并在被查询时就变得过时。如果您使用此值来恢复数据,请确保考虑从查询该值到启动恢复的时间。 |
point_in_time_recovery_enablement | 是否在此数据库上启用 PITR 功能。 |
app_engine_integration_mode | 用于此数据库的 App Engine 集成模式。 |
key_prefix | 仅输出。该数据库的 key_prefix。此 key_prefix 与项目 id 结合使用(“ 该值可能为空,在这种情况下,用于 URL 编码键的 appid 是project_id(例如:foo 而不是 v~foo)。 |
delete_protection_state | 数据库的删除保护状态。 |
etag | 该校验和由服务器根据其他字段的值计算,并且可以在更新和删除请求时发送,以确保客户端在继续操作之前具有最新的值。 |
AppEngine集成模式
App Engine 集成模式的类型。
枚举 | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED | 不曾用过。 |
ENABLED | 如果 App Engine 应用程序与此数据库位于同一区域,则 App Engine 配置将影响此数据库。这包括禁用应用程序和数据库,以及禁用对数据库的写入。 |
DISABLED | App Engine 不会影响该数据库处理请求的能力。 这是使用 Firestore API 创建的数据库的默认设置。 |
并发模式
事务的并发控制模式类型。
枚举 | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED | 不曾用过。 |
OPTIMISTIC | 默认使用乐观并发控制。此模式适用于 Cloud Firestore 数据库。 |
PESSIMISTIC | 默认使用悲观并发控制。此模式适用于 Cloud Firestore 数据库。 这是 Cloud Firestore 的默认设置。 |
OPTIMISTIC_WITH_ENTITY_GROUPS | 默认情况下对实体组使用乐观并发控制。 这是 Cloud Datastore 的唯一可用模式。 此模式也适用于具有数据存储模式的 Cloud Firestore,但不推荐。 |
数据库类型
数据库的类型。有关如何选择的信息,请参阅https://cloud.google.com/datastore/docs/firestore-or-datastore 。
仅当数据库为空时才允许模式更改。
枚举 | |
---|---|
DATABASE_TYPE_UNSPECIFIED | 默认值。如果省略数据库类型,则使用此值。 |
FIRESTORE_NATIVE | Firestore 本机模式 |
DATASTORE_MODE | 数据存储模式下的 Firestore。 |
删除保护状态
数据库的删除保护状态。
枚举 | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED | 默认值。未指定删除保护类型 |
DELETE_PROTECTION_DISABLED | 删除保护已禁用 |
DELETE_PROTECTION_ENABLED | 删除保护已启用 |
时间点恢复启用
时间点恢复功能启用。
枚举 | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED | 不曾用过。 |
POINT_IN_TIME_RECOVERY_ENABLED | 支持读取过去 7 天内选定的数据版本:
|
POINT_IN_TIME_RECOVERY_DISABLED | 支持读取过去 1 小时内任何版本的数据。 |
删除备份请求
领域 | |
---|---|
name | 必需的。要删除的备份的名称。 格式为 |
删除备份计划请求
[FirestoreAdmin.DeleteBackupSchedules][] 的请求。
领域 | |
---|---|
name | 必需的。备份计划的名称。 格式化 |
删除数据库元数据
该类型没有字段。
与删除数据库操作相关的元数据。
删除数据库请求
领域 | |
---|---|
name | 必需的。表单名称 |
etag | 数据库的当前 etag。如果提供的 etag 与数据库当前的 etag 不匹配,删除将被阻止,并返回 FAILED_PRECONDITION 错误。 |
删除索引请求
领域 | |
---|---|
name | 必需的。表单名称 |
导出文档元数据
来自FirestoreAdmin.ExportDocuments
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 该操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
operation_state | 出口操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
collection_ids[] | 正在导出哪些集合 ID。 |
output_uri_prefix | 文件导出到的地方。 |
namespace_ids[] | 正在导出哪些命名空间 ID。 |
snapshot_time | 与正在导出的数据库版本相对应的时间戳。如果未指定,则无法保证导出文档的一致性。 |
出口文件请求
领域 | |
---|---|
name | 必需的。要导出的数据库。应采用以下形式: |
collection_ids[] | 要导出哪个集合 ID。未指定是指所有集合。 |
output_uri_prefix | 输出 URI。目前仅支持以下形式的 Google Cloud Storage URI: |
namespace_ids[] | 空列表代表所有命名空间。这是不使用命名空间的数据库的首选用法。 空字符串元素表示默认命名空间。如果数据库在非默认命名空间中有数据,但又不想包含它们,则应使用此方法。此列表中的每个命名空间都必须是唯一的。 |
snapshot_time | 与要导出的数据库版本对应的时间戳。时间戳必须是过去的,四舍五入到分钟并且不早于 |
出口单据响应
在google.longrunning.Operation
响应字段中返回。
领域 | |
---|---|
output_uri_prefix | 输出文件的位置。这可用于在操作成功完成后开始导入 Cloud Firestore(此项目或另一个项目)。 |
场地
代表数据库中的单个字段。
字段按“集合组”分组,代表数据库中具有相同 id 的所有集合。
领域 | |
---|---|
name | 必需的。字段名称的形式 字段路径可以是简单的字段名称,例如 字段路径可以使用 示例:(注意:这里的注释是用 Markdown 语法写的,所以多了一层反引号来表示代码块) 特殊 |
index_config | 该字段的索引配置。如果未设置,字段索引将恢复为 |
ttl_config | 该 |
索引配置
该字段的索引配置。
领域 | |
---|---|
indexes[] | 该字段支持的索引。 |
uses_ancestor_config | 仅输出。当为 true 时, |
ancestor_field | 仅输出。指定 |
reverting | 仅输出 如果为 true,则 |
时间配置
设置了此Field
的文档的 TTL(生存时间)配置。
将时间戳值存储到启用 TTL 的字段中将被视为文档的绝对过期时间。过去的时间戳值表明该文档可以立即过期。使用任何其他数据类型或不存在该字段将禁用单个文档的过期时间。
领域 | |
---|---|
state | 仅输出。 TTL 配置的状态。 |
状态
将 TTL 配置应用于所有文档的状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定或未知。 |
CREATING | 正在应用 TTL。有一个活动的长期运行的操作来跟踪更改。新编写的文档将根据要求应用 TTL。现有文档上请求的 TTL 仍在处理中。当所有现有文档的 TTL 均已处理完毕后,状态将变为“ACTIVE”。 |
ACTIVE | TTL 对所有文档都有效。 |
NEEDS_REPAIR | 无法为所有现有文档启用 TTL 配置。新编写的文档将继续应用其 TTL。上次尝试为此Field 启用 TTL 失败时返回的 LRO,并且可能包含更多详细信息。 |
字段操作元数据
来自FirestoreAdmin.UpdateField
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
field | 此操作所作用的字段资源。例如: |
index_config_deltas[] | |
state | 操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
ttl_config_delta | 描述 TTL 配置的增量。 |
索引配置增量
有关索引配置更改的信息。
领域 | |
---|---|
change_type | 指定索引如何变化。 |
index | 索引正在更改。 |
更改类型
指定索引如何变化。
枚举 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 更改的类型未指定或未知。 |
ADD | 正在添加单字段索引。 |
REMOVE | 单字段索引正在被删除。 |
Ttl配置增量
有关 TTL 配置更改的信息。
领域 | |
---|---|
change_type | 指定 TTL 配置如何更改。 |
更改类型
指定 TTL 配置如何更改。
枚举 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 更改的类型未指定或未知。 |
ADD | 正在添加 TTL 配置。 |
REMOVE | TTL 配置正在被删除。 |
获取备份请求
领域 | |
---|---|
name | 必需的。要获取的备份的名称。 格式为 |
获取备份计划请求
领域 | |
---|---|
name | 必需的。备份计划的名称。 格式化 |
获取数据库请求
领域 | |
---|---|
name | 必需的。表单名称 |
获取字段请求
领域 | |
---|---|
name | 必需的。表单名称 |
获取索引请求
领域 | |
---|---|
name | 必需的。表单名称 |
导入文件元数据
来自FirestoreAdmin.ImportDocuments
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
operation_state | 导入操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
collection_ids[] | 正在导入哪些集合 ID。 |
input_uri_prefix | 正在导入的文档的位置。 |
namespace_ids[] | 正在导入哪些命名空间 ID。 |
进口文件请求
领域 | |
---|---|
name | 必需的。要导入的数据库。应采用以下形式: |
collection_ids[] | 要导入哪个集合 ID。未指定表示导入中包含的所有集合。 |
input_uri_prefix | 导出文件的位置。这必须与已成功完成导出的 ExportDocumentsResponse 的 output_uri_prefix 匹配。请参阅: |
namespace_ids[] | 空列表代表所有命名空间。这是不使用命名空间的数据库的首选用法。 空字符串元素表示默认命名空间。如果数据库在非默认命名空间中有数据,但又不想包含它们,则应使用此方法。此列表中的每个命名空间都必须是唯一的。 |
指数
Cloud Firestore 索引支持对数据库中的文档进行简单和复杂的查询。
领域 | |
---|---|
name | 仅输出。服务器为此索引定义的名称。复合索引的名称格式为: |
query_scope | 指定集合查询范围的索引允许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有相同的集合 ID。 指定集合组查询范围的索引允许查询源自特定文档、在查询时指定且与该索引具有相同集合 ID 的所有集合。 |
api_scope | 该索引支持的 API 范围。 |
fields[] | 该索引支持的字段。 对于复合索引,这需要最少 2 个、最多 100 个字段。最后一个字段条目始终针对字段路径 对于单字段索引,这始终是一个字段路径等于关联字段的字段路径的条目。 |
state | 仅输出。索引的服务状态。 |
API范围
API 范围定义查询支持的 API(Firestore Native 或数据存储模式下的 Firestore)。
枚举 | |
---|---|
ANY_API | 该索引只能由 Firestore 本机查询 API 使用。这是默认设置。 |
DATASTORE_MODE_API | 该索引只能由 Firestore 在数据存储模式查询 API 中使用。 |
索引字段
索引中的一个字段。 field_path描述了哪个字段被索引,value_mode描述了字段值如何被索引。
领域 | |
---|---|
field_path | 可以是名字。对于单字段索引,它必须与字段名称匹配,也可以省略。 |
联合字段value_mode 。字段值的索引方式。 value_mode 只能是以下之一: | |
order | 表示该字段支持按指定顺序排序或使用=、!=、<、<=、>、>=进行比较。 |
array_config | 表示该字段支持对 |
数组配置
支持的数组值配置。
枚举 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED | 该索引不支持额外的数组查询。 |
CONTAINS | 索引支持数组包含查询。 |
命令
支持的订购。
枚举 | |
---|---|
ORDER_UNSPECIFIED | 顺序未指定。不是一个有效的选项。 |
ASCENDING | 该字段按字段值升序排序。 |
DESCENDING | 该字段按字段值降序排序。 |
查询范围
查询范围定义查询运行的范围。这是在 StructuredQuery 的from
字段上指定的。
枚举 | |
---|---|
QUERY_SCOPE_UNSPECIFIED | 查询范围未指定。不是一个有效的选项。 |
COLLECTION | 指定集合查询范围的索引允许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有由索引指定的集合 ID。 |
COLLECTION_GROUP | 指定集合组查询范围的索引允许查询具有索引指定的集合 ID 的所有集合。 |
COLLECTION_RECURSIVE | 将所有集合的祖先包含在索引中。仅适用于数据存储模式数据库。 |
状态
索引的状态。在索引创建过程中,索引将处于CREATING
状态。如果索引创建成功,则会转入READY
状态。如果索引创建遇到问题,索引将转换为NEEDS_REPAIR
状态。
枚举 | |
---|---|
STATE_UNSPECIFIED | 状态未指定。 |
CREATING | 正在创建索引。该索引存在活跃的长期运行操作。写入文档时索引会更新。可能存在一些索引数据。 |
READY | 该索引已准备好可供使用。写入文档时索引会更新。该索引完全由它所适用的所有存储文档填充。 |
NEEDS_REPAIR | 正在创建索引,但出了点问题。该索引没有活动的长时间运行操作,并且最近完成的长时间运行操作失败。写入文档时索引不会更新。可能存在一些索引数据。使用 google.longrunning.Operations API 确定上次尝试创建此索引的操作失败的原因,然后重新创建索引。 |
索引操作元数据
来自FirestoreAdmin.CreateIndex
的google.longrunning.Operation
结果的元数据。
领域 | |
---|---|
start_time | 此操作开始的时间。 |
end_time | 此操作完成的时间。如果操作仍在进行中,则将被取消设置。 |
index | 此操作所作用的索引资源。例如: |
state | 操作的状态。 |
progress_documents | 该操作的进展(以文件形式)。 |
progress_bytes | 此操作的进度(以字节为单位)。 |
列出备份计划请求
领域 | |
---|---|
parent | 必需的。父数据库。 格式为 |
列出备份计划响应
领域 | |
---|---|
backup_schedules[] | 所有备份计划的列表。 |
列出备份请求
领域 | |
---|---|
parent | 必需的。列出备份的位置。 格式为 |
列出备份响应
领域 | |
---|---|
backups[] | 项目的所有备份的列表。 |
unreachable[] | 无法从中获取现有备份的位置列表。 当单个位置无法访问时,此响应不会使整个请求失败,而是返回部分结果集和无法访问的位置列表。可以针对单个位置重试该请求以获得具体错误。 |
列出数据库请求
请求列出项目所有位置的 Firestore 数据库。
领域 | |
---|---|
parent | 必需的。表单的父级名称 |
列出数据库响应
项目的数据库列表。
领域 | |
---|---|
databases[] | 项目中的数据库。 |
unreachable[] | 如果无法列出有关各个数据库的数据,它们将记录在此处。 示例条目可能是:projects/some_project/locations/some_location 如果数据库所在的云区域当前不可用,则可能会发生这种情况。在这种情况下,我们无法获取有关数据库的所有详细信息。您可以通过发送资源的“获取”请求或特定位置的“列表”请求来获取更详细的错误消息(或者可能获取资源)。 |
列表字段请求
领域 | |
---|---|
parent | 必需的。 |
filter | 应用到列表结果的过滤器。目前, |
page_size | 返回的结果数。 |
page_token | 一个页面令牌,从以前的呼叫返回到 |
ListFieldSresponse
领域 | |
---|---|
fields[] | 请求的字段。 |
next_page_token | 可以用来要求另一页的结果的页面令牌。如果空白,这是最后一页。 |
ListIndexesRequest
领域 | |
---|---|
parent | 必需的。表单 |
filter | 适用于列表结果的过滤器。 |
page_size | 返回的结果数。 |
page_token | 一个页面令牌,从以前的呼叫返回到 |
ListIndexEsesponse
领域 | |
---|---|
indexes[] | 请求的索引。 |
next_page_token | 可以用来要求另一页的结果的页面令牌。如果空白,这是最后一页。 |
LocationMetadata
这种类型没有字段。
OperationState
描述操作的状态。
枚举 | |
---|---|
OPERATION_STATE_UNSPECIFIED | 未指定。 |
INITIALIZING | 正在准备处理的请求。 |
PROCESSING | 请求正在积极处理。 |
CANCELLING | 请求正在用户称为google.longrunning.operations.canceloperation在操作上后取消。 |
FINALIZING | 请求已被处理并处于最终确定阶段。 |
SUCCESSFUL | 请求已成功完成。 |
FAILED | 请求已完成,但遇到了错误。 |
CANCELLED | 用户称为google.longrunning.operations.canceloperation之后,请求已被取消。 |
进步
描述操作的进度。工作单位是通用的,必须根据使用Progress
位置来解释。
领域 | |
---|---|
estimated_work | 估计工作量。 |
completed_work | 完成的工作量完成。 |
还原
元数据用于[rectoreDoreDatabase] [google.firestore.admin.v1.restoredatabase]的long-running operation
。
领域 | |
---|---|
start_time | 还原开始的时间。 |
end_time | 还原完成的时间,尚不确定正在进行的还原。 |
operation_state | 还原的操作状态。 |
database | 数据库的名称要恢复到。 |
backup | 从恢复的备份名称。 |
progress_percentage | 沿着还原多远是剩余时间的估计百分比。 |
恢复原状
[firestoreadmin.restoredatabase] [google.firestore.admin.v1.restoredatabase]的请求消息。
领域 | |
---|---|
parent | 必需的。恢复数据库的项目。格式是 |
database_id | 必需的。用于数据库的ID将成为数据库资源名称的最终组件。此数据库ID不得与现有数据库关联。 该值应为 4-63 个字符。有效字符为 / [az] [0-9] - /带有第一个字符的字母和最后一个字母或数字。不得类似于 UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。 “(默认)”数据库ID也有效。 |
联合现场 | |
backup | 备份要还原。必须来自与父母同一项目。 格式为: |
updatebackupschedulerequest
领域 | |
---|---|
backup_schedule | 必需的。更新的备份时间表。 |
update_mask | 要更新的字段列表。 |
更新的atabasemetadata
这种类型没有字段。
元数据与更新数据库操作有关。
更新的Atatabaserequest
领域 | |
---|---|
database | 必需的。要更新的数据库。 |
update_mask | 要更新的字段列表。 |
UpdateFieldRequest
领域 | |
---|---|
field | 必需的。要更新的字段。 |
update_mask | 一个面具,相对于领域。如果指定,则仅在该字段中更新此字段_mask指定的配置。 |
每周复发
代表在一周中指定的一天进行的重复时间表。
时区是UTC。
领域 | |
---|---|
day | 一周中的一天。 day_of_week_unspecified不允许。 |