Package google.firestore.admin.v1

索引

Firestore管理者

Cloud Firestore 管理 API。

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

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

操作: 操作は、バックグラウンドで実行されている作業を表します。

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

インデックスの作成は非同期で実行されます。操作リソースは、そのような非同期操作ごとに作成されます。操作の状態 (発生したエラーを含む) は、Operation リソースを介して照会できます。

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

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

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

バックアップスケジュールの作成

rpc CreateBackupSchedule( CreateBackupScheduleRequest ) returns ( BackupSchedule )

データベース上にバックアップ スケジュールを作成します。データベースには最大で 2 つのバックアップ スケジュールを構成できます。1 つは最長 7 日間保持される日次バックアップ スケジュール、もう 1 つは最長 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

詳細については、 「認証の概要」を参照してください。

GetBackupSchedule

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 、明示的にオーバーライドされたフィールドのリストのみをサポートしています。このクエリを発行するには、フィルタをindexConfig.usesAncestorConfig:falseまたはttlConfig:*に設定してFirestoreAdmin.ListFieldsを呼び出します。

認可範囲

次の 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タイプになります。

データベースのデフォルトのフィールド設定を構成するには、リソース名を持つ特別なFieldを使用します: projects/{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

毎週特定の日時に実行されるスケジュールの場合。

CreateBackupScheduleRequest

FirestoreAdmin.CreateBackupScheduleのリクエスト。

田畑
parent

string

必須。親データベース。

形式projects/{project}/databases/{database}

backup_schedule

BackupSchedule

必須。作成するバックアップ スケジュール。

データベースメタデータの作成

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

データベース作成操作に関連するメタデータ。

CreateDatabaseRequest

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も有効です。

CreateIndexRequest

FirestoreAdmin.CreateIndexのリクエスト。

田畑
parent

string

必須。 projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}形式の親名

index

Index

必須。作成する複合インデックス。

毎日の繰り返し

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

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

タイムゾーンは UTC です。

データベース

クラウド 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

出力のみ。過去のバージョンのデータがデータベースに保存される期間。

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

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

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削除保護が有効になっています

PointInTimeRecoveryEnablement

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

列挙型
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED使用されていない。
POINT_IN_TIME_RECOVERY_ENABLED

読み取りは、過去 7 日間以内のデータの選択されたバージョンでサポートされています。

  • 過去 1 時間以内のタイムスタンプを読み取ります
  • 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}

ドキュメントメタデータのエクスポート

google.longrunning.OperationのメタデータはFirestoreAdmin.ExportDocumentsから得られます。

田畑
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 記号文字。

例: (注: ここのコメントはマークダウン構文で記述されているため、コード ブロックを表すバックティックの追加レイヤーがあります) \ address.city` は、 in the field address , not the map key address.city represents a field named . `*` は、任意のフィールドではなく、*` represents a field named

特別なFieldは、すべてのフィールドのデフォルトのインデックス設定が含まれています。このフィールドのリソース名は次のとおりです。projects 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のリソース名 ( uses_ancestor_configが true の場合)、またはこのフィールドにインデックス構成がない場合 ( uses_ancestor_configが false の場合) に設定れるフィールドのリソース名を指定します。

reverting

bool

出力のみ true の場合、 Fieldのインデックス構成は元に戻されています。完了すると、インデックス構成はancestor_fieldで指定されたフィールドと同じ状態に遷移します。その時点で、 uses_ancestor_config trueになり、 revertingfalseになります。

TtlConfig

このFieldセットを持つドキュメントの TTL (有効期限) 設定。

TTL が有効なフィールドにタイムスタンプ値を保存すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値は、ドキュメントが即時有効期限切れになる可能性があることを示します。他のデータ型を使用するか、フィールドを省略したままにすると、個々のドキュメントの有効期限が無効になります。

田畑
state

State

出力のみ。 TTL 構成の状態。

すべてのドキュメントにTTL設定を適用した状態。

列挙型
STATE_UNSPECIFIED状態は未指定または不明です。
CREATING TTLが適用されています。変更を追跡するためのアクティブな長時間実行操作があります。新しく書かれたドキュメントには、要求に応じて TTL が適用されます。既存のドキュメントで要求された TTL はまだ処理中です。すべての既存のドキュメントの TTL が処理されると、状態は「ACTIVE」に移行します。
ACTIVE TTL はすべてのドキュメントに対して有効です。
NEEDS_REPAIRすべての既存のドキュメントに対して TTL 構成を有効にすることができませんでした。新しく書かれたドキュメントには引き続き TTL が適用されます。このFieldの TTL を最後に有効にしようとして失敗したときに返された LRO には、詳細が含まれている可能性があります。

フィールド操作メタデータ

google.longrunning.OperationのメタデータはFirestoreAdmin.UpdateFieldから得られます。

田畑
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

インデックスが変更されています。

変更タイプ

インデックスがどのように変化するかを指定します。

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

TtlConfigDelta

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

田畑
change_type

ChangeType

TTL 構成がどのように変更されるかを指定します。

変更タイプ

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}

ドキュメントメタデータのインポート

google.longrunning.OperationのメタデータはFirestoreAdmin.ImportDocumentsから得られます。

田畑
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 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 に並べられます。

単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールド パスと等しいフィールド パスを持つ 1 つのエントリになります。

state

State

出力のみ。インデックスの提供状態。

アピスコープ

API スコープは、クエリでサポートされる API (Firestore ネイティブ、またはデータストア モードの Firestore) を定義します。

列挙型
ANY_APIインデックスは Firestore ネイティブ クエリ API でのみ使用できます。これがデフォルトです。
DATASTORE_MODE_APIインデックスは、データストア モードの Firestore クエリ API でのみ使用できます。

インデックスフィールド

インデックス内のフィールド。 field_path はどのフィールドにインデックスが付けられるかを示し、value_mode はフィールド値がどのようにインデックス付けされるかを示します。

田畑
field_path

string

nameを指定できます。単一フィールドのインデックスの場合、これはフィールドの名前と一致する必要があります。そうでない場合は省略できます。

共用体フィールドvalue_mode 。フィールド値のインデックス付け方法。 value_mode次のいずれか 1 つだけです。
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を使用して、最後にこのインデックスを作成しようとした操作が失敗した理由を判断し、インデックスを再作成します。

IndexOperationMetadata

google.longrunning.Operationのメタデータは、 FirestoreAdmin.CreateIndexの結果です。

田畑
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

既存のバックアップが取得できなかった場所のリスト。

単一の場所が到達不可能な場合にリクエスト全体に障害を失う代わりに、この応答は、ここで到達できない部分的な結果セットと場所のリストを返します。具体的なエラーを取得するために、単一の場所に対してリクエストを再試行できます。

ListDataBaseRequest

プロジェクトのすべての場所のファイヤーストアデータベースをリストするリクエスト。

田畑
parent

string

必須。フォームprojects/{project_id}

ListDataBaseResponse

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

田畑
databases[]

Database

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

unreachable[]

string

個々のデータベースに関するデータをリストできない場合、ここに記録されます。

エントリの例は次のとおりです。プロジェクト/some_project/locations/some_locationこれは、データベースが存在するクラウド領域が現在利用できない場合に発生する可能性があります。この場合、データベースに関するすべての詳細を取得することはできません。リソースの「取得」要求または特定の場所の「リスト」リクエストを送信することにより、より詳細なエラーメッセージ(またはリソースを取得する可能性がある)を取得できる場合があります。

ListFieldSrequest

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への以前の呼び出しから返されたページトークンは、結果の次のページを取得するために使用できます。

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使用される場所に基づいて解釈する必要があります。

田畑
estimated_work

int64

推定される作業量。

completed_work

int64

完了した作業の量。

復元されたタバセメタダタ

[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

復元に沿った距離は、残り時間の推定割合です。

復元されたatabaseRequest

[firestoreadmin.restoredatabase] [google.firestore.admin.v1.restoredatabase]のリクエストメッセージ。

田畑
parent

string

必須。データベースを復元するプロジェクト。形式はprojects/{project_id}です。

database_id

string

必須。データベースに使用するIDは、データベースのリソース名の最終コンポーネントになります。このデータベースIDは、既存のデータベースに関連付けられてはなりません。

この値は4〜63文字でなければなりません。有効な文字は / [az] [0-9] - /最初の文字が文字で、最後の文字または数字です。 uuid-like /[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は許可されていません。