Package google.firestore.admin.v1

string

出力専用。バックアップの一意のリソース名。

形式は projects/{project}/locations/{location}/backups/{backup} です。

string

出力専用。バックアップ元の Firestore データベースの名前。

形式は projects/{project}/databases/{database} です。

string

出力専用。バックアップ元の Firestore データベースのシステム生成 UUID4。

Timestamp

出力専用。この時点で、バックアップにはデータベースの外部整合性のあるコピーが含まれています。

Timestamp

出力専用。このバックアップが期限切れになるタイムスタンプ。

State

出力専用。バックアップの現在の状態。

string

出力専用。指定されたプロジェクトのすべてのロケーションとデータベースにわたる一意のバックアップ スケジュール ID。

これは自動的に割り当てられます。

形式は projects/{project}/databases/{database}/backupSchedules/{backup_schedule} です

Timestamp

出力専用。このバックアップ スケジュールが作成されてから有効になった時点のタイムスタンプ。

このスケジュールのバックアップは、この時間より前に作成されません。

Timestamp

出力専用。このバックアップ スケジュールが最後に更新されたタイムスタンプ。バックアップ スケジュールを最初に作成したときは、create_time と同じです。

Duration

バックアップを作成時点と比較して、将来の相対的な時刻（例:バックアップを 7 日間保持します

サポートされる最大保持期間は 14 週間です。

DailyRecurrence

毎日実行されるスケジュールの場合。

WeeklyRecurrence

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

string

必須。親データベース。

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

BackupSchedule

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

string

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

Database

必須。作成するデータベース。

string

必須。データベースに使用する ID。データベースのリソース名の最終的なコンポーネントになります。

この値は 4 ～ 63 文字にする必要があります。有効な文字は /[a-z][0-9]-/ で、先頭は英字、末尾は英字または数字です。UUID のような /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ にすることはできません。

"(default)"データベース ID も有効です。

string

必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} フォームの親名

Index

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

string

データベースのリソース名。形式: projects/{project}/databases/{database}

string

出力専用。このデータベースに対してシステムによって生成された UUID4。

Timestamp

出力専用。このデータベースが作成された時点のタイムスタンプ。2016 年より前に作成されたデータベースでは、create_time に値が設定されません。

Timestamp

出力専用。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータの更新は含まれないことに注意してください。

Timestamp

出力専用。このデータベースが削除された時点のタイムスタンプ。データベースが削除された場合にのみ設定されます。

string

データベースのロケーション。利用可能なロケーションについては、https://cloud.google.com/firestore/docs/locations をご覧ください。

DatabaseType

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

ConcurrencyMode

このデータベースに使用する同時実行制御モード。

Duration

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

任意の read または query は、このウィンドウ内で read_time を指定でき、その時点でのデータベースの状態を読み取ります。

PITR 機能が有効な場合、保持期間は 7 日間です。それ以外の場合の保持期間は 1 時間です。

Timestamp

出力専用。古いバージョンのデータをデータベースから読み取れる最も古いタイムスタンプ。上記の [version_retention_period] をご覧ください。このフィールドには now - version_retention_period が入力されます。

この値は継続的に更新され、クエリを実行するとすぐに陳腐化します。この値を使用してデータを復元する場合、値がクエリされてから復元を行うまでの間に経過した時間を考慮する必要があります。

PointInTimeRecoveryEnablement

このデータベースで PITR 機能を有効にするかどうかを指定します。

AppEngineIntegrationMode

このデータベースに使用する App Engine 統合モード。

string

出力専用。このデータベースの key_prefix。この key_prefix をプロジェクト ID（「~」）と組み合わせて使用し、Google App Engine 第 1 世代ランタイムの Cloud Datastore API から返されるアプリケーション ID を作成します。

この値は空でもかまいません。この場合、URL エンコードされたキーに使用する appid は project_id です（例: v~foo ではなく foo を使用します）。

DeleteProtectionState

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

CmekConfig

省略可。存在する場合は、このデータベースで CMEK が有効になっていることを示します。

string

出力専用。データベース リソースの以前のデータベース ID。このフィールドは、削除されたデータベースに対してのみ入力されます。

string

このチェックサムは、他のフィールドの値に基づいてサーバーによって計算されて、更新リクエストと削除リクエストで送信され、続行する前にクライアントが最新の値を持っていることを確認できます。

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} です。

string

出力専用。現在使用中の KMS 鍵バージョン。鍵のローテーション中は、複数の使用中の鍵バージョンが存在する可能性があります。

想定される形式は projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} です。

string

必須。削除するバックアップの名前。

形式は projects/{project}/locations/{location}/backups/{backup} です。

string

必須。バックアップ スケジュールの名前。

形式: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

必須。projects/{project_id}/databases/{database_id} フォームの名前

string

データベースの現在の ETag。指定された etag がデータベースの現在の etag と一致しない場合、削除はブロックされ、FAILED_PRECONDITION エラーが返されます。

string

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

Timestamp

このオペレーションの開始時刻。

Timestamp

このオペレーションが完了した時刻。オペレーションがまだ進行中の場合は、設定されません。

OperationState

エクスポート オペレーションの状態。

Progress

このオペレーションの進行状況（ドキュメント）。

Progress

このオペレーションの進行状況（バイト単位）。

string

エクスポートするコレクション ID。

string

ドキュメントのエクスポート先。

string

エクスポート対象の名前空間 ID。

Timestamp

エクスポートされるデータベースのバージョンに対応するタイムスタンプ。指定しない場合、エクスポートされるドキュメントの整合性は保証されません。

string

必須。エクスポートするデータベース。projects/{project_id}/databases/{database_id} の形式にする必要があります。

string

エクスポートするコレクション ID。指定しない場合は、すべてのコレクションが使用されます。このリストの各コレクション ID は一意である必要があります。

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 がバケット（名前空間パスなし）の場合、開始時間に基づいて接頭辞が生成されます。

string

空のリストはすべての Namespace を表します。名前空間を使用しないデータベースには、これが推奨される使用方法です。

空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるものの、それらを含めたくない場合に使用します。このリストの各名前空間は一意である必要があります。

Timestamp

エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは、分単位で四捨五入され、earliestVersionTime 以下である必要があります。指定すると、エクスポートされたドキュメントは、指定された時点でのデータベースの一貫したビューを表します。それ以外の場合、エクスポートされたドキュメントの整合性は保証されません。

string

出力ファイルの場所。これを使用すると、オペレーションが正常に完了した後に Cloud Firestore（このプロジェクトまたは別のプロジェクト）へのインポートを開始できます。

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 インデックス構成を持たないすべてのフィールドに適用されます。

IndexConfig

このフィールドのインデックス構成。設定しない場合、フィールドのインデックス作成は ancestor_field で定義された構成に戻ります。このフィールドのすべてのインデックスを明示的に削除するには、インデックスの空のリストを使用してインデックス構成を指定します。

TtlConfig

この Field の TTL 構成。この設定を設定または設定解除すると、この Field が含まれるドキュメントの TTL が有効または無効になります。

Index

このフィールドでサポートされているインデックス。

bool

出力専用。true の場合、Field のインデックス構成は ancestor_field で指定された構成から設定されます。false の場合、Field のインデックス構成は明示的に定義されます。

string

出力専用。このフィールドのインデックス構成の設定元（uses_ancestor_config が true の場合）またはこのフィールドにインデックス構成がない場合（uses_ancestor_config が false の場合）の設定元となる Field のリソース名を指定します。

bool

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

State

出力専用。TTL 構成の状態。

Timestamp

このオペレーションの開始時刻。

Timestamp

このオペレーションが完了した時刻。オペレーションがまだ進行中の場合は、設定されません。

string

このオペレーションの対象となるフィールド リソース。例: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

IndexConfigDelta

このオペレーションのインテントを記述する IndexConfigDelta のリスト。

OperationState

オペレーションの状態。

Progress

このオペレーションの進行状況（ドキュメント）。

Progress

このオペレーションの進行状況（バイト単位）。

TtlConfigDelta

TTL 構成の差分を示します。

ChangeType

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

Index

変更されるインデックス。

ChangeType

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

string

必須。取得するバックアップの名前。

形式は projects/{project}/locations/{location}/backups/{backup} です。

string

必須。バックアップ スケジュールの名前。

形式: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

必須。projects/{project_id}/databases/{database_id} フォームの名前

string

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

string

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

Timestamp

このオペレーションの開始時刻。

Timestamp

このオペレーションが完了した時刻。オペレーションがまだ進行中の場合は、設定されません。

OperationState

インポート オペレーションの状態。

Progress

このオペレーションの進行状況（ドキュメント）。

Progress

このオペレーションの進行状況（バイト単位）。

string

インポートするコレクション ID。

string

インポートされるドキュメントの場所。

string

インポートされる名前空間 ID。

string

必須。インポート先のデータベース。projects/{project_id}/databases/{database_id} の形式にする必要があります。

string

インポートするコレクション ID。指定しない場合は、インポートに含まれるすべてのコレクションを指定します。

string

エクスポートされたファイルの場所。これは、正常に完了したエクスポートの ExportDocumentsResponse の output_uri_prefix と一致する必要があります。参照: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix

string

空のリストはすべての Namespace を表します。名前空間を使用しないデータベースには、これが推奨される使用方法です。

空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるものの、それらを含めたくない場合に使用します。このリストの各名前空間は一意である必要があります。

string

出力専用。このインデックスのサーバー定義名。複合インデックスの場合、この名前の形式は projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} になります。単一フィールド インデックスの場合、このフィールドは空になります。

QueryScope

コレクション クエリ スコープが指定されたインデックスでは、クエリ時に指定され、同じコレクション ID を持つ特定のドキュメントの子であるコレクションに対してクエリを実行できます。

コレクション グループのクエリ スコープが指定されたインデックスでは、クエリ時に指定された特定のドキュメントの子孫で、このインデックスと同じコレクション ID を持つすべてのコレクションに対してクエリが許可されます。

ApiScope

このインデックスでサポートされている API スコープ。

IndexField

このインデックスでサポートされているフィールド。

複合インデックスの場合、2 ～ 100 個のフィールドが必要です。最後のフィールド エントリは、常にフィールドパス __name__ のものです。作成時に __name__ が最後のフィールドとして指定されていない場合は、最後に定義されたフィールドと同じ方向で自動的に追加されます。複合インデックスの最後のフィールドに方向性がない場合、__name__ は（明示的に指定しない限り）ASCENDING に並べ替えられます。

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

State

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

string

name を指定できます。単一フィールド インデックスの場合は、フィールドの名前と一致させるか、省略できます。

Order

このフィールドで、指定された順序による並べ替え、または =、!=、<、<=、>、>= を使用した比較がサポートされていることを示します。

ArrayConfig

このフィールドが array_value のオペレーションをサポートしていることを示します。

VectorConfig

このフィールドでは、ベクトルに対する最近傍演算と距離演算がサポートされていることを示します。

int32

必須。この設定が適用されるベクトル ディメンション。

結果のインデックスにはこの次元のベクトルのみが含まれ、同じ次元のベクトル検索に使用できます。

FlatIndex

ベクトル インデックスがフラット インデックスであることを示します。

Timestamp

このオペレーションの開始時刻。

Timestamp

このオペレーションが完了した時刻。オペレーションがまだ進行中の場合は、設定されません。

string

このオペレーションの対象となるインデックス リソース。例: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

OperationState

オペレーションの状態。

Progress

このオペレーションの進行状況（ドキュメント）。

Progress

このオペレーションの進行状況（バイト単位）。

string

必須。親データベース。

形式は projects/{project}/databases/{database} です。

BackupSchedule

すべてのバックアップ スケジュールのリスト。

string

必須。バックアップを一覧表示するロケーション。

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

Backup

プロジェクトのすべてのバックアップのリスト。

string

既存のバックアップを取得できなかったロケーションのリスト。

このレスポンスでは、1 つの場所にアクセスできない場合にリクエスト全体が失敗するのではなく、部分的な結果セットと、ここでアクセスできない場所のリストが返されます。1 つのロケーションに対してリクエストを再試行すると、具体的なエラーを取得できます。

string

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

bool

true の場合、削除されたリソースも返されます。

Database

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

string

個々のデータベースに関するデータを一覧表示できない場合は、ここに記録されます。

エントリの例: projects/some_project/locations/some_location これは、データベースが存在する Cloud リージョンが現在利用できない場合に発生します。この場合、データベースに関するすべての詳細を取得することはできません。「Get」を送信することで、より詳細なエラー メッセージを取得できる（またはリソースを取得できる）場合があります。「List」というオブジェクトを含むリクエストできます。

string

必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} フォームの親名

string

リスト結果に適用するフィルタ。現在、FirestoreAdmin.ListFields は、明示的にオーバーライドされたフィールドの一覧表示のみをサポートしています。このクエリを発行するには、indexConfig.usesAncestorConfig:false または ttlConfig:* を含むフィルタで FirestoreAdmin.ListFields を呼び出します。

int32

返される結果の数です。

string

前回の FirestoreAdmin.ListFields 呼び出しから返されたページトークン。結果の次のページを取得するために使用できます。

Field

リクエストされたフィールド。

string

結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。

string

必須。projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} フォームの親名

string

リスト結果に適用するフィルタ。

int32

返される結果の数です。

string

前回の FirestoreAdmin.ListIndexes 呼び出しから返されたページトークン。結果の次のページを取得するために使用できます。

Index

リクエストされたインデックス。

string

結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。

int64

推定作業量。

int64

完了した作業の量。

Timestamp

復元が開始された時刻。

Timestamp

復元が完了した時刻。進行中の復元については未設定。

OperationState

復元の操作状態。

string

復元先のデータベースの名前。

string

復元元のバックアップの名前。

Progress

復元の進捗度を残りの時間に対する推定パーセンテージで示します。

string

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

string

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

この値は 4 ～ 63 文字にする必要があります。有効な文字は /[a-z][0-9]-/ で、先頭は英字、末尾は英字または数字です。UUID のような /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ にすることはできません。

"(default)"データベース ID も有効です。

string

復元元のバックアップ。親と同じプロジェクトのものである必要があります。

形式は projects/{project_id}/locations/{location}/backups/{backup} です。

BackupSchedule

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

FieldMask

更新するフィールドのリスト。

Database

必須。更新するデータベース。

FieldMask

更新するフィールドのリスト。

Field

必須。更新するフィールド。

FieldMask

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

DayOfWeek

実行する曜日。

DAY_OF_WEEK_UNSPECIFIED は使用できません。