Package google.firestore.admin.v1

索引

• FirestoreAdmin（インターフェース）
• Backup（メッセージ）
• Backup.State（列挙型）
• BackupSchedule（メッセージ）
• CreateBackupScheduleRequest（メッセージ）
• CreateDatabaseMetadata（メッセージ）
• CreateDatabaseRequest（メッセージ）
• CreateIndexRequest（メッセージ）
• DailyRecurrence（メッセージ）
• Database（メッセージ）
• Database.AppEngineIntegrationMode（列挙型）
• Database.CmekConfig（メッセージ）
• 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.IndexField.VectorConfig（メッセージ）
• Index.IndexField.VectorConfig.FlatIndex（メッセージ）
• 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 Admin API。

この API は、Cloud Firestore 用にいくつかの管理サービスを提供します。

プロジェクト、データベース、名前空間、コレクション、コレクション グループ、ドキュメントが、Google Cloud Firestore API の定義に従って使用される。

オペレーション: オペレーションは、バックグラウンドで実行されている作業を表します。

インデックス サービスは Cloud Firestore のインデックスを管理します。

インデックスの作成は非同期で行われます。オペレーション リソースは、このような非同期オペレーションごとに作成されます。オペレーションの状態（発生したエラーを含む）は、オペレーション リソースを介してクエリできます。

Operations コレクションは、指定したプロジェクトに対して実行されたアクションの記録を提供します（進行中のオペレーションを含む）。オペレーションは直接作成されるのではなく、他のコレクションまたはリソースに対する呼び出しによって作成されます。

実行されたオペレーションは削除できるので、オペレーション コレクションの一部として表示されなくなります。オペレーションは 30 日後にガベージ コレクションされます。デフォルトでは、ListOperations は進行中のオペレーションと失敗したオペレーションのみを返します。完了したオペレーションを一覧表示するには、フィルタ done: true を使用して ListOperations リクエストを発行します。

オペレーションはサービス FirestoreAdmin によって作成されますが、サービス google.longrunning.Operations を介してアクセスされます。

バックアップ スケジュールの作成
rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule) データベースのバックアップ スケジュールを作成します。1 つのデータベースに設定できるバックアップ スケジュールは 2 つまでです（日次バックアップ スケジュールと週次バックアップ スケジュール）。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

CreateDatabase
rpc CreateDatabase(CreateDatabaseRequest) returns (Operation) データベースを作成します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

CreateIndex
rpc CreateIndex(CreateIndexRequest) returns (Operation) 複合インデックスを作成します。これは google.longrunning.Operation を返します。これを使用して作成のステータスを追跡できます。オペレーションのメタデータは IndexOperationMetadata タイプになります。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteBackup
rpc DeleteBackup(DeleteBackupRequest) returns (Empty) バックアップを削除します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteBackupSchedule
rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty) バックアップ スケジュールを削除します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteDatabase
rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation) データベースを削除します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

DeleteIndex
rpc DeleteIndex(DeleteIndexRequest) returns (Empty) 複合インデックスを削除します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ExportDocuments

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 詳細については、認証の概要をご覧ください。

GetBackup
rpc GetBackup(GetBackupRequest) returns (Backup) バックアップに関する情報を取得します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetBackupSchedule
rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule) バックアップ スケジュールに関する情報を取得します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

GetDatabase
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 詳細については、認証の概要をご覧ください。

ListBackupSchedules
rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse) バックアップ スケジュールを一覧表示します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListBackups
rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse) すべてのバックアップを一覧表示します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListDatabases
rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse) プロジェクト内のすべてのデータベースを一覧表示します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse) このデータベースのフィールド構成とメタデータを一覧表示します。 現在、FirestoreAdmin.ListFields は、明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、フィルタを indexConfig.usesAncestorConfig:false または ttlConfig:* に設定して FirestoreAdmin.ListFields を呼び出します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

ListIndex
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 詳細については、認証の概要をご覧ください。

UpdateBackupSchedule
rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule) バックアップ スケジュールを更新します。 認可スコープ 以下のいずれかの OAuth スコープが必要です。 https://www.googleapis.com/auth/datastore https://www.googleapis.com/auth/cloud-platform 詳細については、認証の概要をご覧ください。

UpdateDatabase
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 タイプになります。 データベースのデフォルトのフィールド設定を構成するには、projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* というリソース名の特別な Field を使用します。 認可スコープ 以下のいずれかの 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 出力専用。指定されたプロジェクトのすべてのロケーションとデータベースにわたる一意のバックアップ スケジュール ID。 これは自動的に割り当てられます。 形式は projects/{project}/databases/{database}/backupSchedules/{backup_schedule} です
create_time	Timestamp 出力専用。このバックアップ スケジュールが作成されてから有効になった時点のタイムスタンプ。 このスケジュールのバックアップは、この時間より前に作成されません。
update_time	Timestamp 出力専用。このバックアップ スケジュールが最後に更新されたタイムスタンプ。バックアップ スケジュールを最初に作成したときは、create_time と同じです。
retention	Duration 作成時点と比較して、将来の相対的な時刻（バックアップを 7 日間保持するなど）で、バックアップを削除する必要があります。 サポートされる最大保持期間は 14 週間です。
共用体フィールド recurrence。バックアップが作成されるタイミングを表す oneof フィールド。recurrence は次のいずれかになります。
daily_recurrence	DailyRecurrence 毎日実行されるスケジュールの場合。
weekly_recurrence	WeeklyRecurrence 毎週特定の日に実行するスケジュールの場合。

CreateBackupScheduleRequest

FirestoreAdmin.CreateBackupSchedule のリクエスト。

フィールド
parent	string 必須。親データベース。 形式: projects/{project}/databases/{database}
backup_schedule	BackupSchedule 必須。作成するバックアップ スケジュール。

CreateDatabaseMetadata

この型にはフィールドがありません。

データベースの作成オペレーションに関連するメタデータ。

CreateDatabaseRequest

FirestoreAdmin.CreateDatabase のリクエスト。

フィールド
parent	string 必須。projects/{project_id} フォームの親名
database	Database 必須。作成するデータベース。
database_id	string 必須。データベースに使用する ID。データベースのリソース名の最終的なコンポーネントになります。 この値は 4 ～ 63 文字にする必要があります。有効な文字は /[a-z][0-9]-/ で、先頭は英字、末尾は英字または数字です。UUID のような /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ にすることはできません。 「（デフォルト）」のデータベース ID も有効です。

CreateIndexRequest

FirestoreAdmin.CreateIndex のリクエスト。

フィールド
parent	string 必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} フォームの親名
index	Index 必須。作成する複合インデックス。

1 日の繰り返し

この型にはフィールドがありません。

毎日実行される定期的なスケジュールを表します。

タイムゾーンは UTC です。

データベース

Cloud Firestore データベース。

フィールド
name	string データベースのリソース名。形式: projects/{project}/databases/{database}
uid	string 出力専用。このデータベースに対してシステムによって生成された UUID4。
create_time	Timestamp 出力専用。このデータベースが作成された時点のタイムスタンプ。2016 年より前に作成されたデータベースでは、create_time に値が設定されません。
update_time	Timestamp 出力専用。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータの更新は含まれないことに注意してください。
delete_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 出力専用。過去のバージョンのデータがデータベースに保持される期間。 任意の read または query は、このウィンドウ内で 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 第 1 世代ランタイムの Cloud Datastore API から返されるアプリケーション ID を作成します。 この値は空でもかまいません。この場合、URL エンコードされたキーに使用する appid は project_id です（例: v~foo ではなく foo を使用します）。
delete_protection_state	DeleteProtectionState データベースの削除保護の状態。
cmek_config	CmekConfig 省略可。存在する場合は、このデータベースで CMEK が有効になっていることを示します。
previous_id	string 出力専用。データベース リソースの以前のデータベース ID。このフィールドは、削除されたデータベースに対してのみ入力されます。
etag	string このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

AppEngineIntegrationMode

App Engine 統合モードのタイプ。

列挙型
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED	使用されません。
ENABLED	App Engine アプリケーションがこのデータベースと同じリージョンにある場合、App Engine の構成はこのデータベースに影響します。これには、アプリケーションとデータベースの無効化、データベースへの書き込みの無効化が含まれます。
DISABLED	App Engine は、このデータベースのリクエストを処理する機能に影響しません。 これは、Firestore API で作成されたデータベースのデフォルト設定です。

CmekConfig

Firestore データベースの CMEK（顧客管理の暗号鍵）構成。存在しない場合、データベースはデフォルトの Google 暗号鍵によって保護されます。

フィールド
kms_key_name	string 必須。暗号化に使用できるのは、このデータベースと同じロケーションにある鍵のみです。 Firestore の nam5 マルチリージョンの場合、これは Cloud KMS マルチリージョンの us に対応します。Firestore の eur3 マルチリージョンの場合、これは Cloud KMS マルチリージョン（ヨーロッパ）に対応します。https://cloud.google.com/kms/docs/locations をご覧ください。 想定される形式は projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} です。
active_key_version[]	string 出力専用。現在使用中の KMS 鍵バージョン。鍵のローテーション中は、複数の使用中の鍵バージョンが存在する可能性があります。 想定される形式は projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} です。

ConcurrencyMode

トランザクションの同時実行制御モードのタイプ。

列挙型
CONCURRENCY_MODE_UNSPECIFIED	使用されません。
OPTIMISTIC	オプティミスティック同時実行制御をデフォルトで使用します。このモードは Cloud Firestore データベースで使用できます。
PESSIMISTIC	ペシミスティック同時実行制御をデフォルトで使用する。このモードは Cloud Firestore データベースで使用できます。 これは Cloud Firestore のデフォルト設定です。
OPTIMISTIC_WITH_ENTITY_GROUPS	デフォルトで、エンティティ グループでオプティミスティック同時実行制御を使用します。 Cloud Datastore ではこのモードのみを使用できます。 このモードは、Datastore モードの Cloud Firestore でも使用できますが、おすすめしません。

DatabaseType

データベースのタイプ。選択方法については、https://cloud.google.com/datastore/docs/firestore-or-datastore をご覧ください。

モードの変更は、データベースが空の場合にのみ許可されます。

列挙型
DATABASE_TYPE_UNSPECIFIED	デフォルト値。データベースの種類を省略すると、この値が使用されます。
FIRESTORE_NATIVE	Firestore ネイティブ モード
DATASTORE_MODE	Datastore モードの Firestore。

DeleteProtectionState

データベースの削除保護の状態。

列挙型
DELETE_PROTECTION_STATE_UNSPECIFIED	デフォルト値。削除保護タイプが指定されていません
DELETE_PROTECTION_DISABLED	削除保護が無効になっています
DELETE_PROTECTION_ENABLED	削除保護が有効です

ポイントインタイム リカバリの有効化

ポイントインタイム リカバリ機能の有効化

列挙型
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED	使用されません。
POINT_IN_TIME_RECOVERY_ENABLED	読み取りは、過去 7 日間のデータの一部のバージョンでサポートされています。 過去 1 時間以内の任意のタイムスタンプに対して読み取ります 1 時間を超えて 7 日以内の 1 分間のスナップショットを読み取る version_retention_period と earliest_version_time を使用すると、サポートされているバージョンを確認できます。
POINT_IN_TIME_RECOVERY_DISABLED	読み取りは、過去 1 時間以内のデータの任意のバージョンでサポートされています。

DeleteBackupRequest

FirestoreAdmin.DeleteBackup のリクエスト。

フィールド
name	string 必須。削除するバックアップの名前。 形式は projects/{project}/locations/{location}/backups/{backup} です。

DeleteBackupScheduleRequest

[FirestoreAdmin.DeleteBackupSchedules][] に対するリクエスト。

フィールド
name	string 必須。バックアップ スケジュールの名前。 形式: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

DeleteDatabaseMetadata

この型にはフィールドがありません。

データベースの削除オペレーションに関連するメタデータ。

DeleteDatabaseRequest

FirestoreAdmin.DeleteDatabase のリクエスト。

フィールド
name	string 必須。projects/{project_id}/databases/{database_id} フォームの名前
etag	string データベースの現在の ETag。指定された etag がデータベースの現在の etag と一致しない場合、削除はブロックされ、FAILED_PRECONDITION エラーが返されます。

DeleteIndexRequest

FirestoreAdmin.DeleteIndex のリクエスト。

フィールド
name	string 必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} フォームの名前

ExportDocumentsMetadata

FirestoreAdmin.ExportDocuments からの google.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 エクスポートされるデータベースのバージョンに対応するタイムスタンプ。指定しない場合、エクスポートされるドキュメントの整合性は保証されません。

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments のリクエスト。

フィールド
name	string 必須。エクスポートするデータベース。projects/{project_id}/databases/{database_id} の形式にする必要があります。
collection_ids[]	string エクスポートするコレクション ID。指定しない場合は、すべてのコレクションが使用されます。
output_uri_prefix	string 出力 URI。現在、gs://BUCKET_NAME[/NAMESPACE_PATH] という形式の Google Cloud Storage URI のみがサポートされています。ここで、BUCKET_NAME は Google Cloud Storage バケットの名前、NAMESPACE_PATH はオプションの Google Cloud Storage 名前空間パスです。名前を選択する際は、Google Cloud Storage の命名ガイドライン（https://cloud.google.com/storage/docs/naming）を考慮してください。URI がバケット（名前空間パスなし）の場合、開始時間に基づいて接頭辞が生成されます。
namespace_ids[]	string 空のリストはすべての Namespace を表します。名前空間を使用しないデータベースには、これが推奨される使用方法です。 空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるものの、それらを含めたくない場合に使用します。このリストの各名前空間は一意である必要があります。
snapshot_time	Timestamp エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは、分単位で四捨五入され、earliestVersionTime 以下である必要があります。指定すると、エクスポートされたドキュメントは、指定された時点でのデータベースの一貫したビューを表します。それ以外の場合、エクスポートされたドキュメントの整合性は保証されません。

ExportDocumentsResponse

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 記号文字を使用して引用符で囲むことができます。 例: （注: ここでのコメントはマークダウン構文で記述されているため、コードブロックを表すためにバッククォートのレイヤが追加されます）\address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`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 が有効または無効になります。

IndexConfig

このフィールドのインデックス構成。

フィールド
indexes[]	Index このフィールドでサポートされているインデックス。
uses_ancestor_config	bool 出力専用。true の場合、Field のインデックス構成は ancestor_field で指定された構成から設定されます。false の場合、Field のインデックス構成は明示的に定義されます。
ancestor_field	string 出力専用。このフィールドのインデックス構成の設定元（uses_ancestor_config が true の場合）またはこのフィールドにインデックス構成がない場合（uses_ancestor_config が false の場合）の設定元となる Field のリソース名を指定します。
reverting	bool 出力のみ true の場合、Field のインデックス構成を元に戻しています。完了すると、インデックス構成は ancestor_field で指定されたフィールドと同じ状態に遷移します。この時点で、uses_ancestor_config は true、reverting は false になります。

tlConfig

この Field が設定されているドキュメントの TTL（有効期間）構成。

TTL が有効なフィールドにタイムスタンプ値を格納すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値が、ドキュメントが即時有効期限の対象であることを示しています。他のデータ型を使用したり、フィールドを空白のままにしたりすると、個々のドキュメントの有効期限が無効になります。

フィールド
state	State 出力専用。TTL 構成の状態。

状態

すべてのドキュメントに TTL 構成を適用している状態。

列挙型
STATE_UNSPECIFIED	状態が未指定または不明です。
CREATING	TTL を適用しています。変更を追跡するアクティブな長時間実行オペレーションがあります。新たに作成されたドキュメントには、リクエストに応じて TTL が適用されます。既存のドキュメントでリクエストされた TTL がまだ処理中です。既存のすべてのドキュメントの TTL が処理されると、状態は「ACTIVE」に移行します。
ACTIVE	TTL は、すべてのドキュメントで有効です。
NEEDS_REPAIR	既存のドキュメントの一部で TTL 構成を有効にできませんでした。新しく作成されたドキュメントには、引き続き TTL が適用されます。この Field の TTL の有効化を最後に試みたときに失敗したときに返された LRO。詳細情報が含まれている可能性があります。

FieldOperationMetadata

FirestoreAdmin.UpdateField からの google.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 構成の差分を示します。

IndexConfigDelta

インデックス構成の変更に関する情報。

フィールド
change_type	ChangeType インデックスの変更方法を指定します。
index	Index 変更されるインデックス。

ChangeType

インデックスの変更方法を指定します。

列挙型
CHANGE_TYPE_UNSPECIFIED	変更の種類が特定されていないか、不明です。
ADD	単一フィールド インデックスを追加しています。
REMOVE	単一フィールド インデックスを削除しています。

TtlConfigDelta

TTL 構成の変更に関する情報。

フィールド
change_type	ChangeType TTL 構成の変更方法を指定します。

ChangeType

TTL 構成の変更方法を指定します。

列挙型
CHANGE_TYPE_UNSPECIFIED	変更の種類が特定されていないか、不明です。
ADD	TTL 構成を追加しています。
REMOVE	TTL 構成を削除しています。

GetBackupRequest

FirestoreAdmin.GetBackup のリクエスト。

フィールド
name	string 必須。取得するバックアップの名前。 形式は projects/{project}/locations/{location}/backups/{backup} です。

GetBackupScheduleRequest

FirestoreAdmin.GetBackupSchedule のリクエスト。

フィールド
name	string 必須。バックアップ スケジュールの名前。 形式: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

FirestoreAdmin.GetDatabase のリクエスト。

フィールド
name	string 必須。projects/{project_id}/databases/{database_id} フォームの名前

GetFieldRequest

FirestoreAdmin.GetField のリクエスト。

フィールド
name	string 必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id} フォームの名前

GetIndexRequest（インデックス リクエスト）

FirestoreAdmin.GetIndex のリクエスト。

フィールド
name	string 必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} フォームの名前

ImportDocumentsMetadata

FirestoreAdmin.ImportDocuments からの google.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。

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.v1.ExportDocumentsResponse.output_uri_prefix
namespace_ids[]	string 空のリストはすべての Namespace を表します。名前空間を使用しないデータベースには、これが推奨される使用方法です。 空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるものの、それらを含めたくない場合に使用します。このリストの各名前空間は一意である必要があります。

索引

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__ は昇順で並べ替えられます（明示的に指定されていない場合）。 単一フィールド インデックスの場合、これは常に 1 つのエントリであり、関連フィールドのフィールドパスと等しいフィールドパスを持ちます。
state	State 出力専用。インデックスの提供状態。

ApiScope

API スコープは、クエリでサポートされている API（Firestore ネイティブまたは Datastore モードの Firestore）を定義します。

列挙型
ANY_API	インデックスは Firestore ネイティブ クエリ API でのみ使用できます。グローバル ウィンドウはデフォルト。
DATASTORE_MODE_API	インデックスは、Datastore モードの Firestore クエリ API でのみ使用できます。

インデックス フィールド

インデックス内のフィールド。field_path はインデックスを付けるフィールドを示し、value_mode はフィールド値のインデックスを示します。

フィールド
field_path	string name を指定できます。単一フィールド インデックスの場合は、フィールドの名前と一致させるか、省略できます。
共用体フィールド value_mode。フィールドの値にインデックスを付ける方法。value_mode は次のいずれかになります。
order	Order このフィールドで、指定された順序または =、!=、<、<=、>、>= を使用した比較による並べ替えがサポートされていることを示します。
array_config	ArrayConfig このフィールドが array_value のオペレーションをサポートしていることを示します。
vector_config	VectorConfig このフィールドでは、ベクトルに対する最近傍演算と距離演算がサポートされていることを示します。

ArrayConfig

サポートされている配列値の構成。

列挙型
ARRAY_CONFIG_UNSPECIFIED	インデックスは追加の配列クエリをサポートしていません。
CONTAINS	インデックスは、配列包含クエリをサポートしています。

注文

サポートされている順序。

列挙型
ORDER_UNSPECIFIED	順序は指定されていません。有効なオプションではありません。
ASCENDING	フィールドは、フィールド値の昇順で並べ替えられます。
DESCENDING	フィールドは、フィールド値の降順で並べ替えられます。

VectorConfig

ベクトル検索オペレーションをサポートするインデックス構成

フィールド
dimension	int32 必須。この設定が適用されるベクトル ディメンション。 結果のインデックスにはこの次元のベクトルのみが含まれ、同じ次元のベクトル検索に使用できます。
共用体フィールド type。使用されるインデックスのタイプ。type は次のいずれかになります。
flat	FlatIndex ベクトル インデックスがフラット インデックスであることを示します。

フラットインデックス

この型にはフィールドがありません。

ベクトルをフラットなデータ構造に格納し、完全検索をサポートするインデックス。

QueryScope

クエリスコープは、クエリを実行するスコープを定義します。これは、StructuredQuery の from フィールドで指定されます。

列挙型
QUERY_SCOPE_UNSPECIFIED	クエリのスコープが指定されていません。有効なオプションではありません。
COLLECTION	コレクション クエリ スコープが指定されたインデックスでは、クエリ時に指定され、インデックスで指定されたコレクション ID を持つ特定のドキュメントの子であるコレクションに対してクエリを実行できます。
COLLECTION_GROUP	コレクション グループのクエリ スコープが指定されたインデックスでは、インデックスで指定されたコレクション ID を持つすべてのコレクションに対してクエリが許可されます。
COLLECTION_RECURSIVE	コレクションのすべての祖先をインデックスに含めます。Datastore モードのデータベースでのみ使用できます。

状態

インデックスの状態。インデックスの作成中、インデックスは CREATING 状態になります。インデックスが正常に作成されると、READY 状態に移行します。インデックスの作成で問題が発生すると、インデックスは NEEDS_REPAIR 状態に移行します。

列挙型
STATE_UNSPECIFIED	状態は指定されていません。
CREATING	インデックスを作成しています。インデックスに対してアクティブな長時間実行オペレーションがあります。インデックスは、ドキュメントの書き込み時に更新されます。一部のインデックス データが存在する場合があります。
READY	インデックスが使用できるようになりました。インデックスは、ドキュメントの書き込み時に更新されます。インデックスは、そのインデックスが適用される、保存されているすべてのドキュメントから完全に入力されます。
NEEDS_REPAIR	インデックスの作成中にエラーが発生しました。インデックスに対するアクティブな長時間実行オペレーションがなく、最後に終了した長時間実行オペレーションが失敗しました。ドキュメントの書き込み時にインデックスは更新されません。一部のインデックス データが存在する場合があります。google.longrunning.Operations API を使用して、前回このインデックスの作成を試みたオペレーションが失敗した理由を確認し、インデックスを再作成します。

IndexOperationMetadata

FirestoreAdmin.CreateIndex からの google.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 このオペレーションの進行状況（バイト単位）。

ListBackupSchedulesRequest

FirestoreAdmin.ListBackupSchedules のリクエスト。

フィールド
parent	string 必須。親データベース。 形式は projects/{project}/databases/{database} です。

ListBackupSchedulesResponse

FirestoreAdmin.ListBackupSchedules に対するレスポンス。

フィールド
backup_schedules[]	BackupSchedule すべてのバックアップ スケジュールのリスト。

ListBackupsRequest

FirestoreAdmin.ListBackups のリクエスト。

フィールド
parent	string 必須。バックアップを一覧表示するロケーション。 形式は projects/{project}/locations/{location} です。{location} = '-' を使用して、指定したプロジェクトのすべてのロケーションのバックアップを一覧表示します。これにより、単一のロケーションまたはすべてのロケーションのバックアップを一覧表示できます。

ListBackupsResponse

FirestoreAdmin.ListBackups に対するレスポンス。

フィールド
backups[]	Backup プロジェクトのすべてのバックアップのリスト。
unreachable[]	string 既存のバックアップを取得できなかったロケーションのリスト。 このレスポンスでは、1 つの場所にアクセスできない場合にリクエスト全体が失敗するのではなく、部分的な結果セットと、ここでアクセスできない場所のリストが返されます。1 つのロケーションに対してリクエストを再試行すると、具体的なエラーを取得できます。

ListDatabasesRequest

プロジェクトのすべてのロケーションの Firestore データベースを一覧表示するためのリクエスト。

フィールド
parent	string 必須。projects/{project_id} フォームの親名
show_deleted	bool true の場合、削除されたリソースも返されます。

ListDatabasesResponse

プロジェクトのデータベースのリスト。

フィールド
databases[]	Database プロジェクト内のデータベース。
unreachable[]	string 個々のデータベースに関するデータを一覧表示できない場合は、ここに記録されます。 エントリの例: projects/some_project/locations/some_location これは、データベースが存在する Cloud リージョンが現在利用できない場合に発生します。この場合、データベースに関するすべての詳細を取得することはできません。リソースの「Get」リクエストまたは特定のロケーションに対する「List」リクエストを送信すると、より詳細なエラー メッセージを取得できます（場合によってはリソースの取得もできます）。

ListFieldsRequest

FirestoreAdmin.ListFields のリクエスト。

フィールド
parent	string 必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} フォームの親名
filter	string リスト結果に適用するフィルタ。現在、FirestoreAdmin.ListFields は、明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、indexConfig.usesAncestorConfig:false または ttlConfig:* を含むフィルタで 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 呼び出しから返されたページトークン。結果の次のページを取得するために使用できます。

ListIndexesResponse

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

オペレーションの進行状況を表します。作業単位は汎用であり、Progress が使用される場所に基づいて解釈する必要があります。

フィールド
estimated_work	int64 推定作業量。
completed_work	int64 完了した作業の量。

RestoreDatabaseMetadata

[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] リクエストからの long-running operation のメタデータ。

フィールド
start_time	Timestamp 復元が開始された時刻。
end_time	Timestamp 復元が完了した時刻。進行中の復元については未設定。
operation_state	OperationState 復元の操作状態。
database	string 復元先のデータベースの名前。
backup	string 復元元のバックアップの名前。
progress_percentage	Progress 復元の進捗度を残りの時間に対する推定パーセンテージで示します。

RestoreDatabaseRequest

[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] に対するリクエスト メッセージ。

フィールド
parent	string 必須。データベースを復元するプロジェクト。形式は projects/{project_id} です。
database_id	string 必須。データベースに使用する ID。データベースのリソース名の最終的なコンポーネントになります。このデータベース ID は既存のデータベースに関連付けることはできません。 この値は 4 ～ 63 文字にする必要があります。有効な文字は /[a-z][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 更新するフィールドのリスト。

UpdateDatabaseMetadata

この型にはフィールドがありません。

データベースの更新オペレーションに関連するメタデータ。

UpdateDatabaseRequest

FirestoreAdmin.UpdateDatabase のリクエスト。

フィールド
database	Database 必須。更新するデータベース。
update_mask	FieldMask 更新するフィールドのリスト。

UpdateFieldRequest

FirestoreAdmin.UpdateField のリクエスト。

フィールド
field	Field 必須。更新するフィールド。
update_mask	FieldMask フィールドに対する相対的なマスク。指定すると、この field_mask で指定された構成のみがフィールドで更新されます。

週ごとの頻度

指定された曜日に実行される定期的なスケジュールを表します。

タイムゾーンは UTC です。

フィールド
day	DayOfWeek 実行する曜日。 DAY_OF_WEEK_UNSPECIFIED は使用できません。