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 日間保持する）。

DailyRecurrence

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

WeeklyRecurrence

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

string

必須。親データベース。

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

BackupSchedule

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

string

必須。projects/{project_id} 形式の親の名前

Database

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

string

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

この値は 4 ～ 63 文字で指定してください。有効な文字は /[a-z][0-9]-/ で、先頭は英字、最後の文字は英字または数字です。/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ のような UUID にすることはできません。

「(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

出力のみ。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータは含まれません。

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

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

string

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

string

必須。このデータベースと同じロケーションにある鍵のみが暗号化に使用できます。

Firestore の nam5 マルチリージョンの場合、これは Cloud KMS マルチリージョン us に相当します。Firestore の eur3 マルチリージョンの場合、これは Cloud KMS マルチリージョン europe に対応します。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。指定しない場合は、すべてのコレクションになります。

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

空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。

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

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

空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。

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

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__ は（明示的に指定しない限り）昇順になります。

単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールドパスと同じフィールドパスを持つ 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} = '-' を使用して、指定したプロジェクトのすべてのロケーションのバックアップを一覧表示します。これにより、1 つのロケーションまたはすべてのロケーションのバックアップを一覧表示できます。

Backup

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

string

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

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

string

必須。projects/{project_id} 形式の親の名前

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 を含むフィルタを指定して 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]-/ で、先頭は英字、最後の文字は英字または数字です。/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ のような UUID にすることはできません。

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

string

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

形式: projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

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

FieldMask

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

Database

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

FieldMask

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

Field

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

FieldMask

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

DayOfWeek

実行する曜日。

DAY_OF_WEEK_UNSPECIFIED は使用できません。