Package google.firestore.admin.v1

指数

Firestore管理员

Cloud Firestore 管理 API。

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

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

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

索引服务管理 Cloud Firestore 索引。

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

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

已完成的操作可以被删除,以便它不再作为操作集合的一部分列出。 30 天后操作将被垃圾收集。默认情况下,ListOperations 将仅返回正在进行和失败的操作。要列出已完成的操作,请发出带有过滤器done: true ListOperations 请求。

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

创建备份计划

rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )

在数据库上创建备份计划。一个数据库最多可以配置两个备份计划,一个是每日备份计划,保留时间最长为 7 天,另一个是每周备份计划,保留时间最长为 14 周。

授权范围

需要以下 OAuth 范围之一:

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

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

创建数据库

rpc CreateDatabase( CreateDatabaseRequest ) returns ( Operation )

创建数据库。

授权范围

需要以下 OAuth 范围之一:

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

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

创建索引

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

创建复合索引。这会返回一个google.longrunning.Operation ,可用于跟踪创建的状态。操作的元数据将是IndexOperationMetadata类型。

授权范围

需要以下 OAuth 范围之一:

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

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

删除备份

rpc DeleteBackup( DeleteBackupRequest ) returns ( Empty )

删除备份。

授权范围

需要以下 OAuth 范围之一:

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

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

删除备份计划

rpc DeleteBackupSchedule( DeleteBackupScheduleRequest ) returns ( Empty )

删除备份计划。

授权范围

需要以下 OAuth 范围之一:

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

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

删除数据库

rpc DeleteDatabase( DeleteDatabaseRequest ) returns ( Operation )

删除数据库。

授权范围

需要以下 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 中留下部分数据。

有关导出行为和输出格式的更多详细信息,请参阅: https://cloud.google.com/firestore/docs/manage-data/export-import

授权范围

需要以下 OAuth 范围之一:

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

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

重新站起来

rpc GetBackup( GetBackupRequest ) returns ( Backup )

获取有关备份的信息。

授权范围

需要以下 OAuth 范围之一:

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

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

获取备份计划

rpc GetBackupSchedule( GetBackupScheduleRequest ) returns ( BackupSchedule )

获取有关备份计划的信息。

授权范围

需要以下 OAuth 范围之一:

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

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

获取数据库

rpc GetDatabase( GetDatabaseRequest ) returns ( Database )

获取有关数据库的信息。

授权范围

需要以下 OAuth 范围之一:

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

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

获取字段

rpc GetField( GetFieldRequest ) returns ( Field )

获取字段的元数据和配置。

授权范围

需要以下 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 ListBackupSchedules( ListBackupSchedulesRequest ) returns ( ListBackupSchedulesResponse )

列出备份计划。

授权范围

需要以下 OAuth 范围之一:

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

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

备份列表

rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )

列出所有备份。

授权范围

需要以下 OAuth 范围之一:

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

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

列出数据库

rpc ListDatabases( ListDatabasesRequest ) returns ( ListDatabasesResponse )

列出项目中的所有数据库。

授权范围

需要以下 OAuth 范围之一:

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

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

列表字段

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

列出该数据库的字段配置和元数据。

目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请调用FirestoreAdmin.ListFields并将过滤器设置为indexConfig.usesAncestorConfig:falsettlConfig:*

授权范围

需要以下 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

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

恢复数据库

rpc RestoreDatabase( RestoreDatabaseRequest ) returns ( Operation )

通过从现有备份恢复来创建新数据库。

新数据库必须与现有备份位于同一云区域或多区域位置。其行为类似于 [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase],只不过不是创建新的空数据库,而是使用数据库类型、索引配置和现有备份中的文档创建新数据库。

long-running operation可用于跟踪恢复进度,操作的metadata字段类型为RestoreDatabaseMetadata 。如果恢复成功, response类型为Database 。在 LRO 完成之前,新数据库不可读取或写入。

授权范围

需要以下 OAuth 范围之一:

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

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

更新备份计划

rpc UpdateBackupSchedule( UpdateBackupScheduleRequest ) returns ( BackupSchedule )

更新备份计划。

授权范围

需要以下 OAuth 范围之一:

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

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

更新数据库

rpc UpdateDatabase( UpdateDatabaseRequest ) returns ( Operation )

更新数据库。

授权范围

需要以下 OAuth 范围之一:

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

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

更新字段

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

更新字段配置。目前,字段更新仅适用于单字段索引配置。但是,对FirestoreAdmin.UpdateField调用应提供字段掩码,以避免更改调用者不知道的任何配置。字段掩码应指定为: { paths: "index_config" }

此调用返回google.longrunning.Operation ,可用于跟踪字段更新的状态。操作的元数据将是FieldOperationMetadata类型。

要配置数据库的默认字段设置,请使用带有资源名称的特殊Fieldprojects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*

授权范围

需要以下 OAuth 范围之一:

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

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

备份

Cloud Firestore 数据库的备份。

备份包含给定数据库在特定时间点的所有文档和索引配置。

领域
name

string

仅输出。备份的唯一资源名称。

格式为projects/{project}/locations/{location}/backups/{backup}

database

string

仅输出。备份所在的 Firestore 数据库的名称。

格式为projects/{project}/databases/{database}

database_uid

string

仅输出。系统为备份所在的 Firestore 数据库生成的 UUID4。

snapshot_time

Timestamp

仅输出。此时备份包含数据库的外部一致副本。

expire_time

Timestamp

仅输出。此备份到期的时间戳。

state

State

仅输出。备份的当前状态。

状态

指示备份的当前状态。

枚举
STATE_UNSPECIFIED状态未指定。
CREATING仍在创建挂起的备份。在此状态下,对备份的操作将被拒绝。
READY备份已完成并可以使用。
NOT_AVAILABLE备份目前不可用。

备份计划

Cloud Firestore 数据库的备份计划。

该资源归其正在备份的数据库所有,并与数据库一起删除。但实际的备份并非如此。

领域
name

string

仅输出。给定项目的所有位置和数据库的唯一备份计划标识符。

这将被自动分配。

格式为projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

create_time

Timestamp

仅输出。创建此备份计划并自此生效的时间戳。

在此时间之前不会为此计划创建任何备份。

update_time

Timestamp

仅输出。最近更新此备份计划的时间戳。首次创建备份计划时,这与 create_time 相同。

retention

Duration

与备份的创建时间相比,在未来的什么相对时间,应该删除备份,例如保留备份7天。

联盟场recurrence 。表示何时进行备份的 oneof 字段。 recurrence只能是以下情况之一:
daily_recurrence

DailyRecurrence

对于每天在指定时间运行的计划。

weekly_recurrence

WeeklyRecurrence

对于每周在特定日期和时间运行的计划。

创建备份计划请求

FirestoreAdmin.CreateBackupSchedule的请求。

领域
parent

string

必需的。父数据库。

格式化projects/{project}/databases/{database}

backup_schedule

BackupSchedule

必需的。要创建的备份计划。

创建数据库元数据

该类型没有字段。

与创建数据库操作相关的元数据。

创建数据库请求

FirestoreAdmin.CreateDatabase的请求。

领域
parent

string

必需的。表单的父级名称projects/{project_id}

database

Database

必需的。要创建的数据库。

database_id

string

必需的。用于数据库的 ID,它将成为数据库资源名称的最终组成部分。

该值应为 4-63 个字符。有效字符为 /[az][0-9]-/,第一个字符为字母,最后一个字符为字母或数字。不得类似于 UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。

“(默认)”数据库 ID 也有效。

创建索引请求

FirestoreAdmin.CreateIndex的请求。

领域
parent

string

必需的。 projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

必需的。要创建的复合索引。

每日重复

该类型没有字段。

表示每天在特定时间运行的重复计划。

时区为 UTC。

数据库

Cloud Firestore 数据库。

领域
name

string

数据库的资源名称。格式: projects/{project}/databases/{database}

uid

string

仅输出。系统为此数据库生成的 UUID4。

create_time

Timestamp

仅输出。创建此数据库的时间戳。 2016 年之前创建的数据库不会填充 create_time。

update_time

Timestamp

仅输出。该数据库最近更新的时间戳。请注意,这仅包括对数据库资源的更新,而不包括数据库包含的数据。

location_id

string

数据库的位置。 https://cloud.google.com/firestore/docs/locations列出了可用位置。

type

DatabaseType

数据库的类型。有关如何选择的信息,请参阅https://cloud.google.com/datastore/docs/firestore-or-datastore

concurrency_mode

ConcurrencyMode

用于此数据库的并发控制模式。

version_retention_period

Duration

仅输出。过去版本的数据保留在数据库中的时间段。

任何readquery都可以在此窗口内指定一个read_time ,并会读取该时间数据库的状态。

如果启用 PITR 功能,保留期为 7 天。否则,保留期限为 1 小时。

earliest_version_time

Timestamp

仅输出。可以从数据库读取旧版本数据的最早时间戳。请参阅上面的[version_retention_period];该字段填充有now - version_retention_period

该值会不断更新,并在被查询时就变得过时。如果您使用此值来恢复数据,请确保考虑从查询该值到启动恢复的时间。

point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

是否在此数据库上启用 PITR 功能。

app_engine_integration_mode

AppEngineIntegrationMode

用于此数据库的 App Engine 集成模式。

key_prefix

string

仅输出。该数据库的 key_prefix。此 key_prefix 与项目 id 结合使用(“ ") 来构造从 Google App Engine 第一代运行时中的 Cloud Datastore API 返回的应用程序 ID。

该值可能为空,在这种情况下,用于 URL 编码键的 appid 是project_id(例如:foo 而不是 v~foo)。

delete_protection_state

DeleteProtectionState

数据库的删除保护状态。

etag

string

该校验和由服务器根据其他字段的值计算,并且可以在更新和删除请求时发送,以确保客户端在继续操作之前具有最新的值。

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 天内选定的数据版本:

  • 读取过去一小时内的任何时间戳
  • 读取 1 小时以上、7 天内的 1 分钟快照

version_retention_periodearliest_version_time可用于确定支持的版本。

POINT_IN_TIME_RECOVERY_DISABLED支持读取过去 1 小时内任何版本的数据。

删除备份请求

FirestoreAdmin.DeleteBackup的请求。

领域
name

string

必需的。要删除的备份的名称。

格式为projects/{project}/locations/{location}/backups/{backup}

删除备份计划请求

[FirestoreAdmin.DeleteBackupSchedules][] 的请求。

领域
name

string

必需的。备份计划的名称。

格式化projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

删除数据库元数据

该类型没有字段。

与删除数据库操作相关的元数据。

删除数据库请求

FirestoreAdmin.DeleteDatabase的请求。

领域
name

string

必需的。表单名称projects/{project_id}/databases/{database_id}

etag

string

数据库的当前 etag。如果提供的 etag 与数据库当前的 etag 不匹配,删除将被阻止,并返回 FAILED_PRECONDITION 错误。

删除索引请求

FirestoreAdmin.DeleteIndex的请求。

领域
name

string

必需的。表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

导出文档元数据

来自FirestoreAdmin.ExportDocumentsgoogle.longrunning.Operation结果的元数据。

领域
start_time

Timestamp

该操作开始的时间。

end_time

Timestamp

此操作完成的时间。如果操作仍在进行中,则将被取消设置。

operation_state

OperationState

出口操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

此操作的进度(以字节为单位)。

collection_ids[]

string

正在导出哪些集合 ID。

output_uri_prefix

string

文件导出到的地方。

namespace_ids[]

string

正在导出哪些命名空间 ID。

snapshot_time

Timestamp

与正在导出的数据库版本相对应的时间戳。如果未指定,则无法保证导出文档的一致性。

出口文件请求

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

namespace_ids[]

string

空列表代表所有命名空间。这是不使用命名空间的数据库的首选用法。

空字符串元素表示默认命名空间。如果数据库在非默认命名空间中有数据,但又不想包含它们,则应使用此方法。此列表中的每个命名空间都必须是唯一的。

snapshot_time

Timestamp

与要导出的数据库版本对应的时间戳。时间戳必须是过去的,四舍五入到分钟并且不早于earliestVersionTime 。如果指定,则导出的文档将代表指定时间数据库的一致视图。否则,无法保证导出文件的一致性。

出口单据响应

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

领域
output_uri_prefix

string

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

场地

代表数据库中的单个字段。

字段按“集合组”分组,代表数据库中具有相同 id 的所有集合。

领域
name

string

必需的。字段名称的形式projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

字段路径可以是简单的字段名称,例如address或map_value内字段的路径,例如address.city ,或者特殊的字段路径。唯一有效的特殊字段是* ,它代表任何字段。

字段路径可以使用(backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: * , . , ``` (backtick), [ , ]` 以及任何 ascii 符号字符。

示例:(注意:这里的注释是用 Markdown 语法写的,所以多了一层反引号来表示代码块) \ address.city` represents a field named ,而不是in the field , not the map key city . `*` represents a field named ,而不是任何字段。

特殊Field包含所有字段的默认索引设置。该字段的资源名称为: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*在此Field上定义的索引将应用于所有没有自己的Field索引配置的字段。

index_config

IndexConfig

该字段的索引配置。如果未设置,字段索引将恢复为ancestor_field定义的配置。要显式删除该字段的所有索引,请指定带有空索引列表的索引配置。

ttl_config

TtlConfig

Field的 TTL 配置。设置或取消设置此项将启用或禁用具有此Field文档的 TTL。

索引配置

该字段的索引配置。

领域
indexes[]

Index

该字段支持的索引。

uses_ancestor_config

bool

仅输出。当为 true 时, Field的索引配置是根据ancestor_field指定的配置设置的。当为 false 时, Field的索引配置是显式定义的。

ancestor_field

string

仅输出。指定Field的资源名称,从该Field设置该字段的索引配置(当uses_ancestor_config为true时),或者如果该字段没有索引配置(当uses_ancestor_config为false时),则从该Field设置该资源名称。

reverting

bool

仅输出 如果为 true,则Field的索引配置正在恢复。完成后,索引配置将转换为与ancestor_field指定的字段相同的状态,此时uses_ancestor_config将为truereverting将为false

时间配置

设置了此Field的文档的 TTL(生存时间)配置。

将时间戳值存储到启用 TTL 的字段中将被视为文档的绝对过期时间。过去的时间戳值表明该文档可以立即过期。使用任何其他数据类型或不存在该字段将禁用单个文档的过期时间。

领域
state

State

仅输出。 TTL 配置的状态。

状态

将 TTL 配置应用于所有文档的状态。

枚举
STATE_UNSPECIFIED状态未指定或未知。
CREATING正在应用 TTL。有一个活动的长期运行的操作来跟踪更改。新编写的文档将根据要求应用 TTL。现有文档上请求的 TTL 仍在处理中。当所有现有文档的 TTL 均已处理完毕后,状态将变为“ACTIVE”。
ACTIVE TTL 对所有文档都有效。
NEEDS_REPAIR无法为所有现有文档启用 TTL 配置。新编写的文档将继续应用其 TTL。上次尝试为此Field启用 TTL 失败时返回的 LRO,并且可能包含更多详细信息。

字段操作元数据

来自FirestoreAdmin.UpdateFieldgoogle.longrunning.Operation结果的元数据。

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

此操作完成的时间。如果操作仍在进行中,则将被取消设置。

field

string

此操作所作用的字段资源。例如: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

IndexConfigDelta列表,描述此操作的意图。

state

OperationState

操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

此操作的进度(以字节为单位)。

ttl_config_delta

TtlConfigDelta

描述 TTL 配置的增量。

索引配置增量

有关索引配置更改的信息。

领域
change_type

ChangeType

指定索引如何变化。

index

Index

索引正在更改。

更改类型

指定索引如何变化。

枚举
CHANGE_TYPE_UNSPECIFIED更改的类型未指定或未知。
ADD正在添加单字段索引。
REMOVE单字段索引正在被删除。

Ttl配置增量

有关 TTL 配置更改的信息。

领域
change_type

ChangeType

指定 TTL 配置如何更改。

更改类型

指定 TTL 配置如何更改。

枚举
CHANGE_TYPE_UNSPECIFIED更改的类型未指定或未知。
ADD正在添加 TTL 配置。
REMOVE TTL 配置正在被删除。

获取备份请求

FirestoreAdmin.GetBackup的请求。

领域
name

string

必需的。要获取的备份的名称。

格式为projects/{project}/locations/{location}/backups/{backup}

获取备份计划请求

FirestoreAdmin.GetBackupSchedule的请求。

领域
name

string

必需的。备份计划的名称。

格式化projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

获取数据库请求

FirestoreAdmin.GetDatabase的请求。

领域
name

string

必需的。表单名称projects/{project_id}/databases/{database_id}

获取字段请求

FirestoreAdmin.GetField的请求。

领域
name

string

必需的。表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

获取索引请求

FirestoreAdmin.GetIndex的请求。

领域
name

string

必需的。表单名称projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

导入文件元数据

来自FirestoreAdmin.ImportDocumentsgoogle.longrunning.Operation结果的元数据。

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

此操作完成的时间。如果操作仍在进行中,则将被取消设置。

operation_state

OperationState

导入操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

此操作的进度(以字节为单位)。

collection_ids[]

string

正在导入哪些集合 ID。

input_uri_prefix

string

正在导入的文档的位置。

namespace_ids[]

string

正在导入哪些命名空间 ID。

进口文件请求

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.v1.ExportDocumentsResponse.output_uri_prefix

namespace_ids[]

string

空列表代表所有命名空间。这是不使用命名空间的数据库的首选用法。

空字符串元素表示默认命名空间。如果数据库在非默认命名空间中有数据,但又不想包含它们,则应使用此方法。此列表中的每个命名空间都必须是唯一的。

指数

Cloud Firestore 索引支持对数据库中的文档进行简单和复杂的查询。

领域
name

string

仅输出。服务器为此索引定义的名称。复合索引的名称格式为: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}对于单字段索引,此字段将为空。

query_scope

QueryScope

指定集合查询范围的索引允​​许对作为特定文档子级的集合进行查询,该集合是在查询时指定的,并且具有相同的集合 ID。

指定集合组查询范围的索引允​​许查询源自特定文档、在查询时指定且与该索引具有相同集合 ID 的所有集合。

api_scope

ApiScope

该索引支持的 API 范围。

fields[]

IndexField

该索引支持的字段。

对于复合索引,这需要最少 2 个、最多 100 个字段。最后一个字段条目始终针对字段路径__name__ 。如果在创建时未将__name__指定为最后一个字段,则会自动添加该字段,其方向与最后定义的字段相同。如果复合索引中的最后一个字段不是定向的,则__name__将按 ASCENDING 排序(除非明确指定)。

对于单字段索引,这始终是一个字段路径等于关联字段的字段路径的条目。

state

State

仅输出。索引的服务状态。

API范围

API 范围定义查询支持的 API(Firestore Native 或数据存储模式下的 Firestore)。

枚举
ANY_API该索引只能由 Firestore 本机查询 API 使用。这是默认设置。
DATASTORE_MODE_API该索引只能由 Firestore 在数据存储模式查询 API 中使用。

索引字段

索引中的一个字段。 field_path描述了哪个字段被索引,value_mode描述了字段值如何被索引。

领域
field_path

string

可以是名字。对于单字段索引,它必须与字段名称匹配,也可以省略。

联合字段value_mode 。字段值的索引方式。 value_mode只能是以下之一:
order

Order

表示该字段支持按指定顺序排序或使用=、!=、<、<=、>、>=进行比较。

array_config

ArrayConfig

表示该字段支持对array_value的操作。

数组配置

支持的数组值配置。

枚举
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.CreateIndexgoogle.longrunning.Operation结果的元数据。

领域
start_time

Timestamp

此操作开始的时间。

end_time

Timestamp

此操作完成的时间。如果操作仍在进行中,则将被取消设置。

index

string

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

state

OperationState

操作的状态。

progress_documents

Progress

该操作的进展(以文件形式)。

progress_bytes

Progress

此操作的进度(以字节为单位)。

列出备份计划请求

FirestoreAdmin.ListBackupSchedules的请求。

领域
parent

string

必需的。父数据库。

格式为projects/{project}/databases/{database}

列出备份计划响应

FirestoreAdmin.ListBackupSchedules的响应。

领域
backup_schedules[]

BackupSchedule

所有备份计划的列表。

列出备份请求

FirestoreAdmin.ListBackups的请求。

领域
parent

string

必需的。列出备份的位置。

格式为projects/{project}/locations/{location} 。使用{location} = '-'列出给定项目的所有位置的备份。这允许列出来自单个位置或所有位置的备份。

列出备份响应

FirestoreAdmin.ListBackups的响应。

领域
backups[]

Backup

项目的所有备份的列表。

unreachable[]

string

无法从中获取现有备份的位置列表。

当单个位置无法访问时,此响应不会使整个请求失败,而是返回部分结果集和无法访问的位置列表。可以针对单个位置重试该请求以获得具体错误。

列出数据库请求

请求列出项目所有位置的 Firestore 数据库。

领域
parent

string

必需的。表单的父级名称projects/{project_id}

列出数据库响应

项目的数据库列表。

领域
databases[]

Database

项目中的数据库。

unreachable[]

string

如果无法列出有关各个数据库的数据,它们将记录在此处。

示例条目可能是:projects/some_project/locations/some_location 如果数据库所在的云区域当前不可用,则可能会发生这种情况。在这种情况下,我们无法获取有关数据库的所有详细信息。您可以通过发送资源的“获取”请求或特定位置的“列表”请求来获取更详细的错误消息(或者可能获取资源)。

列表字段请求

FirestoreAdmin.ListFields的请求。

领域
parent

string

必需的。 projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

应用到列表结果的过滤器。目前, FirestoreAdmin.ListFields仅支持列出已显式覆盖的字段。要发出此查询,请使用包含indexConfig.usesAncestorConfig:false过滤器调用FirestoreAdmin.ListFields

page_size

int32

返回的结果数。

page_token

string

一个页面令牌,从以前的呼叫返回到FirestoreAdmin.ListFields ,可用于获取结果的下一页。

ListFieldSresponse

FirestoreAdmin.ListFields的响应。

领域
fields[]

Field

请求的字段。

next_page_token

string

可以用来要求另一页的结果的页面令牌。如果空白,这是最后一页。

ListIndexesRequest

FirestoreAdmin.ListIndexes的请求。

领域
parent

string

必需的。表单projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

适用于列表结果的过滤器。

page_size

int32

返回的结果数。

page_token

string

一个页面令牌,从以前的呼叫返回到FirestoreAdmin.ListIndexes ,可用于获取结果的下一页。

ListIndexEsesponse

FirestoreAdmin.ListIndexes的响应。

领域
indexes[]

Index

请求的索引。

next_page_token

string

可以用来要求另一页的结果的页面令牌。如果空白,这是最后一页。

LocationMetadata

这种类型没有字段。

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

OperationState

描述操作的状态。

枚举
OPERATION_STATE_UNSPECIFIED未指定。
INITIALIZING正在准备处理的请求。
PROCESSING请求正在积极处理。
CANCELLING请求正在用户称为google.longrunning.operations.canceloperation在操作上后取消。
FINALIZING请求已被处理并处于最终确定阶段。
SUCCESSFUL请求已成功完成。
FAILED请求已完成,但遇到了错误。
CANCELLED用户称为google.longrunning.operations.canceloperation之后,请求已被取消。

进步

描述操作的进度。工作单位是通用的,必须根据使用Progress位置来解释。

领域
estimated_work

int64

估计工作量。

completed_work

int64

完成的工作量完成。

还原

元数据用于[rectoreDoreDatabase] [google.firestore.admin.v1.restoredatabase]的long-running operation

领域
start_time

Timestamp

还原开始的时间。

end_time

Timestamp

还原完成的时间,尚不确定正在进行的还原。

operation_state

OperationState

还原的操作状态。

database

string

数据库的名称要恢复到。

backup

string

从恢复的备份名称。

progress_percentage

Progress

沿着还原多远是剩余时间的估计百分比。

恢复原状

[firestoreadmin.restoredatabase] [google.firestore.admin.v1.restoredatabase]的请求消息。

领域
parent

string

必需的。恢复数据库的项目。格式是projects/{project_id}

database_id

string

必需的。用于数据库的ID将成为数据库资源名称的最终组件。此数据库ID不得与现有数据库关联。

该值应为 4-63 个字符。有效字符为 / [az] [0-9] - /带有第一个字符的字母和最后一个字母或数字。不得类似于 UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/。

“(默认)”数据库ID也有效。

联合现场source

source只能是以下一个:

backup

string

备份要还原。必须来自与父母同一项目。

格式为: projects/{project_id}/locations/{location}/backups/{backup}

updatebackupschedulerequest

FirestoreAdmin.UpdateBackupSchedule的请求。

领域
backup_schedule

BackupSchedule

必需的。更新的备份时间表。

update_mask

FieldMask

要更新的字段列表。

更新的atabasemetadata

这种类型没有字段。

元数据与更新数据库操作有关。

更新的Atatabaserequest

FirestoreAdmin.UpdateDatabase的请求。

领域
database

Database

必需的。要更新的数据库。

update_mask

FieldMask

要更新的字段列表。

UpdateFieldRequest

FirestoreAdmin.UpdateField的请求。

领域
field

Field

必需的。要更新的字段。

update_mask

FieldMask

一个面具,相对于领域。如果指定,则仅在该字段中更新此字段_mask指定的配置。

每周复发

代表在一周中指定的一天进行的重复时间表。

时区是UTC。

领域
day

DayOfWeek

一周中的一天。

day_of_week_unspecified不允许。