索引
FirestoreAdmin
(インターフェース)-
Backup
(メッセージ) -
Backup.State
(列挙型) -
BackupSchedule
(メッセージ) -
CreateBackupScheduleRequest
(メッセージ) -
CreateDatabaseMetadata
(メッセージ) -
CreateDatabaseRequest
(メッセージ) -
CreateIndexRequest
(メッセージ) -
DailyRecurrence
(メッセージ) -
Database
(メッセージ) -
Database.AppEngineIntegrationMode
(列挙型) -
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.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 管理 API。
この API は、Cloud Firestore にいくつかの管理サービスを提供します。
プロジェクト、データベース、名前空間、コレクション、コレクション グループ、ドキュメントは、Google Cloud Firestore API での定義に従って使用されます。
操作: 操作は、バックグラウンドで実行されている作業を表します。
インデックス サービスは Cloud Firestore インデックスを管理します。
インデックスの作成は非同期で実行されます。操作リソースは、そのような非同期操作ごとに作成されます。操作の状態 (発生したエラーを含む) は、Operation リソースを介して照会できます。
Operations コレクションは、指定されたプロジェクトに対して実行されたアクション (進行中のオペレーションを含む) の記録を提供します。操作は直接作成されるのではなく、他のコレクションまたはリソースの呼び出しを通じて作成されます。
実行されたオペレーションは削除され、オペレーション コレクションの一部としてリストされなくなる場合があります。操作は 30 日後にガベージ コレクションされます。デフォルトでは、ListOperations は進行中の操作と失敗した操作のみを返します。完了した操作を一覧表示するには、フィルターdone: true
を指定して ListOperations リクエストを発行します。
オペレーションはサービスFirestoreAdmin
によって作成されますが、サービスgoogle.longrunning.Operations
を介してアクセスされます。
バックアップスケジュールの作成 |
---|
データベース上にバックアップ スケジュールを作成します。データベースには最大で 2 つのバックアップ スケジュールを構成できます。1 つは最長 7 日間保持される日次バックアップ スケジュール、もう 1 つは最長 14 週間保持される週次バックアップ スケジュールです。
|
データベースの作成 |
---|
データベースを作成します。
|
インデックスの作成 |
---|
複合インデックスを作成します。これにより、作成のステータスを追跡するために使用できる
|
バックアップの削除 |
---|
バックアップを削除します。
|
バックアップスケジュールの削除 |
---|
バックアップ スケジュールを削除します。
|
データベースの削除 |
---|
データベースを削除します。
|
インデックスの削除 |
---|
複合インデックスを削除します。
|
ドキュメントのエクスポート |
---|
ドキュメントのすべてまたはサブセットのコピーを Google Cloud Firestore から別のストレージ システム (Google Cloud Storage など) にエクスポートします。ドキュメントに対する最近の更新がエクスポートに反映されない場合があります。エクスポートはバックグラウンドで実行され、その進行状況は、作成された操作リソースを介して監視および管理できます。エクスポートの出力は、関連する操作が完了した後にのみ使用できます。エクスポート操作が完了前にキャンセルされると、部分的なデータが Google Cloud Storage に残る可能性があります。 エクスポートの動作と出力形式の詳細については、https: //cloud.google.com/firestore/docs/manage-data/export-importを参照してください。
|
バックアップの取得 |
---|
バックアップに関する情報を取得します。
|
GetBackupSchedule |
---|
バックアップ スケジュールに関する情報を取得します。
|
データベースの取得 |
---|
データベースに関する情報を取得します。
|
ゲットフィールド |
---|
フィールドのメタデータと構成を取得します。
|
インデックスの取得 |
---|
複合インデックスを取得します。
|
ドキュメントのインポート |
---|
ドキュメントを Google Cloud Firestore にインポートします。同じ名前の既存のドキュメントは上書きされます。インポートはバックグラウンドで行われ、その進行状況は、作成された操作リソースを介して監視および管理できます。 ImportDocuments オペレーションがキャンセルされた場合、データのサブセットがすでに Cloud Firestore にインポートされている可能性があります。
|
バックアップスケジュールのリスト |
---|
バックアップ スケジュールを一覧表示します。
|
バックアップの一覧表示 |
---|
すべてのバックアップを一覧表示します。
|
データベースのリスト |
---|
プロジェクト内のすべてのデータベースをリストします。
|
リストフィールド |
---|
このデータベースのフィールド構成とメタデータをリストします。 現在、
|
リストインデックス |
---|
複合インデックスをリストします。
|
データベースの復元 |
---|
既存のバックアップから復元して、新しいデータベースを作成します。 新しいデータベースは、既存のバックアップと同じクラウド リージョンまたはマルチリージョンの場所に存在する必要があります。これは、[FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] と同様に動作しますが、新しい空のデータベースを作成する代わりに、データベース タイプ、インデックス構成、既存のバックアップからのドキュメントを使用して新しいデータベースが作成される点が異なります。
|
バックアップスケジュールの更新 |
---|
バックアップ スケジュールを更新します。
|
データベースを更新する |
---|
データベースを更新します。
|
フィールドの更新 |
---|
フィールド構成を更新します。現在、フィールドの更新は単一フィールドのインデックス構成にのみ適用されます。ただし、 この呼び出しは、フィールド更新のステータスを追跡するために使用できる データベースのデフォルトのフィールド設定を構成するには、リソース名を持つ特別な
|
バックアップ
Cloud Firestore データベースのバックアップ。
バックアップには、特定の時点での特定のデータベースのすべてのドキュメントとインデックス構成が含まれます。
田畑 | |
---|---|
name | 出力のみ。バックアップの一意のリソース名。 形式は |
database | 出力のみ。バックアップ元の Firestore データベースの名前。 形式は |
database_uid | 出力のみ。バックアップ元の Firestore データベースのシステム生成の UUID4。 |
snapshot_time | 出力のみ。現時点では、バックアップには外部的に整合性のあるデータベースのコピーが含まれています。 |
expire_time | 出力のみ。このバックアップの有効期限が切れるタイムスタンプ。 |
state | 出力のみ。バックアップの現在の状態。 |
州
バックアップの現在の状態を示します。
列挙型 | |
---|---|
STATE_UNSPECIFIED | 状態は未指定です。 |
CREATING | 保留中のバックアップはまだ作成中です。この状態では、バックアップに対する操作は拒否されます。 |
READY | バックアップが完了し、使用できるようになりました。 |
NOT_AVAILABLE | 現時点ではバックアップは利用できません。 |
バックアップスケジュール
Cloud Firestore データベースのバックアップ スケジュール。
このリソースは、バックアップしているデータベースによって所有されており、データベースとともに削除されます。ただし、実際のバックアップはそうではありません。
田畑 | |
---|---|
name | 出力のみ。特定のプロジェクトのすべての場所およびデータベースにわたる一意のバックアップ スケジュール識別子。 これは自動的に割り当てられます。 形式は |
create_time | 出力のみ。このバックアップ スケジュールが作成され、それ以降有効になったタイムスタンプ。 この時刻より前に、このスケジュールのバックアップは作成されません。 |
update_time | 出力のみ。このバックアップ スケジュールが最後に更新されたタイムスタンプ。バックアップ スケジュールが最初に作成されるとき、これは create_time と同じです。 |
retention | 作成時と比較して、将来の相対的な時点でバックアップを削除する必要があります。たとえば、バックアップを 7 日間保持します。 |
ユニオンフィールドのrecurrence 。バックアップがいつ取得されるかを表す oneof フィールド。 recurrence 次のいずれかのみです。 | |
daily_recurrence | 毎日指定された時刻に実行されるスケジュールの場合。 |
weekly_recurrence | 毎週特定の日時に実行されるスケジュールの場合。 |
CreateBackupScheduleRequest
田畑 | |
---|---|
parent | 必須。親データベース。 形式 |
backup_schedule | 必須。作成するバックアップ スケジュール。 |
データベースメタデータの作成
このタイプにはフィールドがありません。
データベース作成操作に関連するメタデータ。
CreateDatabaseRequest
田畑 | |
---|---|
parent | 必須。形式 |
database | 必須。作成するデータベース。 |
database_id | 必須。データベースに使用する 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 | 必須。 |
index | 必須。作成する複合インデックス。 |
毎日の繰り返し
このタイプにはフィールドがありません。
毎日特定の時刻に実行される定期的なスケジュールを表します。
タイムゾーンは UTC です。
データベース
クラウド Firestore データベース。
田畑 | |
---|---|
name | データベースのリソース名。形式: |
uid | 出力のみ。このデータベースに対してシステムが生成した UUID4。 |
create_time | 出力のみ。このデータベースが作成されたときのタイムスタンプ。 2016 年より前に作成されたデータベースには、create_time が設定されません。 |
update_time | 出力のみ。このデータベースが最後に更新されたときのタイムスタンプ。これにはデータベース リソースへの更新のみが含まれ、データベースに含まれるデータは含まれないことに注意してください。 |
location_id | データベースの場所。利用可能な場所はhttps://cloud.google.com/firestore/docs/locationsにリストされています。 |
type | データベースのタイプ。選択方法については、 https://cloud.google.com/datastore/docs/firestore-or-datastoreを参照してください。 |
concurrency_mode | このデータベースに使用する同時実行制御モード。 |
version_retention_period | 出力のみ。過去のバージョンのデータがデータベースに保存される期間。 PITR 機能が有効な場合、保持期間は 7 日間です。それ以外の場合、保持期間は 1 時間です。 |
earliest_version_time | 出力のみ。古いバージョンのデータをデータベースから読み取ることができる最も古いタイムスタンプ。上記の [version_retention_period] を参照してください。このフィールドには、 この値は継続的に更新され、クエリが行われた時点で古くなります。この値を使用してデータをリカバリする場合は、値がクエリされた瞬間からリカバリを開始するまでの時間を必ず考慮してください。 |
point_in_time_recovery_enablement | このデータベースで PITR 機能を有効にするかどうか。 |
app_engine_integration_mode | このデータベースに使用する App Engine 統合モード。 |
key_prefix | 出力のみ。このデータベースの key_prefix。この key_prefix は、プロジェクト ID (" この値は空であってもよく、その場合、URL エンコードされたキーに使用する appid は project_id になります (例: v~foo の代わりに foo)。 |
delete_protection_state | データベースの削除保護の状態。 |
etag | このチェックサムは、他のフィールドの値に基づいてサーバーによって計算され、続行する前にクライアントが最新の値を持っていることを確認するために、更新および削除リクエストで送信される場合があります。 |
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 日間以内のデータの選択されたバージョンでサポートされています。
|
POINT_IN_TIME_RECOVERY_DISABLED | 読み取りは、過去 1 時間以内のデータの任意のバージョンでサポートされます。 |
バックアップの削除リクエスト
FirestoreAdmin.DeleteBackup
のリクエスト。
田畑 | |
---|---|
name | 必須。削除するバックアップの名前。 形式は |
バックアップスケジュールリクエストの削除
[FirestoreAdmin.DeleteBackupSchedules][] のリクエスト。
田畑 | |
---|---|
name | 必須。バックアップ スケジュールの名前。 形式 |
データベースメタデータの削除
このタイプにはフィールドがありません。
データベースの削除操作に関連するメタデータ。
データベース削除リクエスト
田畑 | |
---|---|
name | 必須。 |
etag | データベースの現在の etag。 etag が指定されていて、データベースの現在の etag と一致しない場合、削除はブロックされ、FAILED_PRECONDITION エラーが返されます。 |
インデックスの削除リクエスト
FirestoreAdmin.DeleteIndex
のリクエスト。
田畑 | |
---|---|
name | 必須。形式の名前 |
ドキュメントメタデータのエクスポート
google.longrunning.Operation
のメタデータはFirestoreAdmin.ExportDocuments
から得られます。
田畑 | |
---|---|
start_time | この操作が開始された時刻。 |
end_time | この操作が完了した時刻。操作がまだ進行中の場合は設定が解除されます。 |
operation_state | エクスポート操作の状態。 |
progress_documents | この作戦の進捗状況を文書で示します。 |
progress_bytes | この操作の進行状況 (バイト単位)。 |
collection_ids[] | どのコレクション ID がエクスポートされているか。 |
output_uri_prefix | ドキュメントのエクスポート先。 |
namespace_ids[] | どの名前空間 ID がエクスポートされているか。 |
snapshot_time | エクスポートされるデータベースのバージョンに対応するタイムスタンプ。指定しない場合、エクスポートされるドキュメントの一貫性については保証されません。 |
ドキュメントのエクスポートリクエスト
田畑 | |
---|---|
name | 必須。エクスポートするデータベース。形式は、 |
collection_ids[] | どのコレクション ID をエクスポートするか。 「未指定」とは、すべてのコレクションを意味します。 |
output_uri_prefix | 出力 URI。現在、次の形式の Google Cloud Storage URI のみをサポートしています: |
namespace_ids[] | 空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースの場合に推奨される使用法です。 空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるが、それらを含めたくない場合に使用する必要があります。このリスト内の各名前空間は一意である必要があります。 |
snapshot_time | エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは分単位に四捨五入され、 |
ドキュメントのエクスポート応答
google.longrunning.Operation
応答フィールドで返されます。
田畑 | |
---|---|
output_uri_prefix | 出力ファイルの場所。これを使用して、操作が正常に完了した後に Cloud Firestore (このプロジェクトまたは別のプロジェクト) へのインポートを開始できます。 |
分野
データベース内の単一のフィールドを表します。
フィールドは、同じ ID を持つデータベース内のすべてのコレクションを表す「コレクション グループ」によってグループ化されます。
田畑 | |
---|---|
name | 必須。 フィールド パスは、単純なフィールド名 (例: フィールド パスは、 例: (注: ここのコメントはマークダウン構文で記述されているため、コード ブロックを表すバックティックの追加レイヤーがあります) 特別な |
index_config | このフィールドのインデックス構成。設定しない場合、フィールドのインデックス付けは |
ttl_config | この |
インデックス構成
このフィールドのインデックス構成。
田畑 | |
---|---|
indexes[] | このフィールドでサポートされているインデックス。 |
uses_ancestor_config | 出力のみ。 true の場合、 |
ancestor_field | 出力のみ。このフィールドのインデックス構成の設定元となる |
reverting | 出力のみ true の場合、 |
TtlConfig
このField
セットを持つドキュメントの TTL (有効期限) 設定。
TTL が有効なフィールドにタイムスタンプ値を保存すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値は、ドキュメントが即時有効期限切れになる可能性があることを示します。他のデータ型を使用するか、フィールドを省略したままにすると、個々のドキュメントの有効期限が無効になります。
田畑 | |
---|---|
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 | この操作が開始された時刻。 |
end_time | この操作が完了した時刻。操作がまだ進行中の場合は設定が解除されます。 |
field | この操作が作用するフィールド リソース。例: |
index_config_deltas[] | この操作の意図を説明する |
state | 操作の状態。 |
progress_documents | この作戦の進捗状況を文書で示します。 |
progress_bytes | この操作の進行状況 (バイト単位)。 |
ttl_config_delta | TTL 構成の差分について説明します。 |
IndexConfigDelta
インデックス構成の変更に関する情報。
田畑 | |
---|---|
change_type | インデックスがどのように変化するかを指定します。 |
index | インデックスが変更されています。 |
変更タイプ
インデックスがどのように変化するかを指定します。
列挙型 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 変更の種類は特定されておらず、不明です。 |
ADD | 単一フィールドのインデックスが追加されます。 |
REMOVE | 単一フィールドのインデックスが削除されています。 |
TtlConfigDelta
TTL 構成の変更に関する情報。
田畑 | |
---|---|
change_type | TTL 構成がどのように変更されるかを指定します。 |
変更タイプ
TTL 構成がどのように変更されるかを指定します。
列挙型 | |
---|---|
CHANGE_TYPE_UNSPECIFIED | 変更の種類は特定されておらず、不明です。 |
ADD | TTL 構成が追加されています。 |
REMOVE | TTL 構成は削除されています。 |
GetBackupRequest
FirestoreAdmin.GetBackup
のリクエスト。
田畑 | |
---|---|
name | 必須。取得するバックアップの名前。 形式は |
GetBackupScheduleRequest
田畑 | |
---|---|
name | 必須。バックアップ スケジュールの名前。 形式 |
GetDatabaseRequest
FirestoreAdmin.GetDatabase
のリクエスト。
田畑 | |
---|---|
name | 必須。 |
GetFieldRequest
FirestoreAdmin.GetField
のリクエスト。
田畑 | |
---|---|
name | 必須。形式の名前 |
GetIndexRequest
FirestoreAdmin.GetIndex
のリクエスト。
田畑 | |
---|---|
name | 必須。形式の名前 |
ドキュメントメタデータのインポート
google.longrunning.Operation
のメタデータはFirestoreAdmin.ImportDocuments
から得られます。
田畑 | |
---|---|
start_time | この操作が開始された時刻。 |
end_time | この操作が完了した時刻。操作がまだ進行中の場合は設定が解除されます。 |
operation_state | インポート操作の状態。 |
progress_documents | この作戦の進捗状況を文書で示します。 |
progress_bytes | この操作の進行状況 (バイト単位)。 |
collection_ids[] | どのコレクション ID がインポートされているか。 |
input_uri_prefix | インポートされるドキュメントの場所。 |
namespace_ids[] | どの名前空間 ID がインポートされているか。 |
ドキュメントのインポートリクエスト
田畑 | |
---|---|
name | 必須。インポート先のデータベース。形式は、 |
collection_ids[] | どのコレクション ID をインポートするか。 「未指定」とは、インポートに含まれるすべてのコレクションを意味します。 |
input_uri_prefix | エクスポートされたファイルの場所。これは、正常に完了したエクスポートからの ExportDocumentsResponse の Output_uri_prefix と一致する必要があります。参照: |
namespace_ids[] | 空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースの場合に推奨される使用法です。 空の文字列要素はデフォルトの名前空間を表します。これは、データベースにデフォルト以外の名前空間にデータがあるが、それらを含めたくない場合に使用する必要があります。このリスト内の各名前空間は一意である必要があります。 |
索引
Cloud Firestore インデックスを使用すると、データベース内のドキュメントに対する単純なクエリと複雑なクエリが可能になります。
田畑 | |
---|---|
name | 出力のみ。このインデックスのサーバー定義の名前。複合インデックスのこの名前の形式は次のようになります。projects |
query_scope | コレクション クエリ スコープが指定されたインデックスでは、クエリ時に指定され、同じコレクション ID を持つ特定のドキュメントの子であるコレクションに対するクエリが許可されます。 コレクション グループ クエリ スコープが指定されたインデックスでは、クエリ時に指定された特定のドキュメントから派生し、このインデックスと同じコレクション ID を持つすべてのコレクションに対するクエリが許可されます。 |
api_scope | このインデックスでサポートされる API スコープ。 |
fields[] | このインデックスでサポートされるフィールド。 複合インデックスの場合、これには最小 2 個、最大 100 個のフィールドが必要です。最後のフィールドエントリは常にフィールドパス 単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールド パスと等しいフィールド パスを持つ 1 つのエントリになります。 |
state | 出力のみ。インデックスの提供状態。 |
アピスコープ
API スコープは、クエリでサポートされる API (Firestore ネイティブ、またはデータストア モードの Firestore) を定義します。
列挙型 | |
---|---|
ANY_API | インデックスは Firestore ネイティブ クエリ API でのみ使用できます。これがデフォルトです。 |
DATASTORE_MODE_API | インデックスは、データストア モードの Firestore クエリ API でのみ使用できます。 |
インデックスフィールド
インデックス内のフィールド。 field_path はどのフィールドにインデックスが付けられるかを示し、value_mode はフィールド値がどのようにインデックス付けされるかを示します。
田畑 | |
---|---|
field_path | nameを指定できます。単一フィールドのインデックスの場合、これはフィールドの名前と一致する必要があります。そうでない場合は省略できます。 |
共用体フィールドvalue_mode 。フィールド値のインデックス付け方法。 value_mode 次のいずれか 1 つだけです。 | |
order | このフィールドが、指定された順序による並べ替え、または =、!=、<、<=、>、>= を使用した比較をサポートすることを示します。 |
array_config | このフィールドが |
配列構成
サポートされている配列値の構成。
列挙型 | |
---|---|
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 | この操作が始まった時。 |
end_time | この操作が完了した時。操作がまだ進行している場合、設定されません。 |
index | この操作が機能しているインデックスリソース。例: |
state | 操作の状態。 |
progress_documents | この操作の文書における進捗。 |
progress_bytes | この操作の進捗状況。 |
listbackupschedulesrequest
田畑 | |
---|---|
parent | 必須。親データベース。 フォーマットは |
listbackupschedulesResponse
田畑 | |
---|---|
backup_schedules[] | すべてのバックアップスケジュールのリスト。 |
ListBackUpsRequest
FirestoreAdmin.ListBackups
のリクエスト。
田畑 | |
---|---|
parent | 必須。バックアップをリストする場所。 フォーマットは |
listbackupsResponse
田畑 | |
---|---|
backups[] | プロジェクトのすべてのバックアップのリスト。 |
unreachable[] | 既存のバックアップが取得できなかった場所のリスト。 単一の場所が到達不可能な場合にリクエスト全体に障害を失う代わりに、この応答は、ここで到達できない部分的な結果セットと場所のリストを返します。具体的なエラーを取得するために、単一の場所に対してリクエストを再試行できます。 |
ListDataBaseRequest
プロジェクトのすべての場所のファイヤーストアデータベースをリストするリクエスト。
田畑 | |
---|---|
parent | 必須。フォーム |
ListDataBaseResponse
プロジェクトのデータベースのリスト。
田畑 | |
---|---|
databases[] | プロジェクトのデータベース。 |
unreachable[] | 個々のデータベースに関するデータをリストできない場合、ここに記録されます。 エントリの例は次のとおりです。プロジェクト/some_project/locations/some_locationこれは、データベースが存在するクラウド領域が現在利用できない場合に発生する可能性があります。この場合、データベースに関するすべての詳細を取得することはできません。リソースの「取得」要求または特定の場所の「リスト」リクエストを送信することにより、より詳細なエラーメッセージ(またはリソースを取得する可能性がある)を取得できる場合があります。 |
ListFieldSrequest
FirestoreAdmin.ListFields
のリクエスト。
田畑 | |
---|---|
parent | 必須。フォームの親名 |
filter | 結果をリストするために適用するフィルター。現在、 |
page_size | 返される結果の数。 |
page_token | |
ListFieldSresponse
田畑 | |
---|---|
fields[] | 要求されたフィールド。 |
next_page_token | 結果の別のページを要求するために使用できるページトークン。空白の場合、これが最後のページです。 |
ListIndexesRequest
FirestoreAdmin.ListIndexes
のリクエスト。
田畑 | |
---|---|
parent | 必須。フォームの親名 |
filter | 結果をリストするために適用するフィルター。 |
page_size | 返される結果の数。 |
page_token | |
ListIndExESResponse
田畑 | |
---|---|
indexes[] | 要求されたインデックス。 |
next_page_token | 結果の別のページを要求するために使用できるページトークン。空白の場合、これが最後のページです。 |
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 | 推定される作業量。 |
completed_work | 完了した作業の量。 |
復元されたタバセメタダタ
[restoredatabase] [google.firestore.admin.v1.restoredatabase]リクエストからのlong-running operation
のメタデータ。
田畑 | |
---|---|
start_time | 復元が開始された時。 |
end_time | 復元が終了した時間は、進行中の復元のために設定されていません。 |
operation_state | 復元の動作状態。 |
database | 復元されているデータベースの名前。 |
backup | からのバックアップの名前の名前。 |
progress_percentage | 復元に沿った距離は、残り時間の推定割合です。 |
復元されたatabaseRequest
[firestoreadmin.restoredatabase] [google.firestore.admin.v1.restoredatabase]のリクエストメッセージ。
田畑 | |
---|---|
parent | 必須。データベースを復元するプロジェクト。形式は |
database_id | 必須。データベースに使用するIDは、データベースのリソース名の最終コンポーネントになります。このデータベースIDは、既存のデータベースに関連付けられてはなりません。 この値は4〜63文字でなければなりません。有効な文字は / [az] [0-9] - /最初の文字が文字で、最後の文字または数字です。 uuid-like /[0-9a-f] {8}( - [0-9a-f] {4}){3} - [0-9a-f] {12} /。 「(デフォルト)」データベースIDも有効です。 |
ユニオンフィールド | |
backup | 復元するためのバックアップ。親と同じプロジェクトからのものでなければなりません。 フォーマットは次のとおりです。 |
updatebackupschedulerequest
田畑 | |
---|---|
backup_schedule | 必須。更新するバックアップスケジュール。 |
update_mask | 更新されるフィールドのリスト。 |
updatedatabasemetadata
このタイプにはフィールドがありません。
更新データベース操作に関連するメタデータ。
updatedatabaserequest
田畑 | |
---|---|
database | 必須。更新するデータベース。 |
update_mask | 更新されるフィールドのリスト。 |
UpdateFieldRequest
FirestoreAdmin.UpdateField
のリクエスト。
田畑 | |
---|---|
field | 必須。更新されるフィールド。 |
update_mask | フィールドに対するマスク。指定されている場合、このfield_maskで指定された構成のみがフィールドで更新されます。 |
毎週の再発
指定された曜日に実行される繰り返しのスケジュールを表します。
タイムゾーンはUTCです。
田畑 | |
---|---|
day | 走る曜日。 day_of_week_unspecifiedは許可されていません。 |