索引
FirestoreAdmin
(インターフェース)Backup
(メッセージ)Backup.State
(列挙型)BackupSchedule
(メッセージ)CreateBackupScheduleRequest
(メッセージ)CreateDatabaseMetadata
(メッセージ)CreateDatabaseRequest
(メッセージ)CreateIndexRequest
(メッセージ)DailyRecurrence
(メッセージ)Database
(メッセージ)Database.AppEngineIntegrationMode
(列挙型)Database.CmekConfig
(メッセージ)Database.ConcurrencyMode
(enum)Database.DatabaseType
(列挙型)Database.DeleteProtectionState
(列挙型)Database.PointInTimeRecoveryEnablement
(enum)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
(enum)Index.IndexField.Order
(enum)Index.IndexField.VectorConfig
(メッセージ)Index.IndexField.VectorConfig.FlatIndex
(メッセージ)Index.QueryScope
(enum)Index.State
(enum)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 のインデックスを管理します。
インデックスの作成は非同期的に行われます。オペレーション リソースは、このような非同期オペレーションごとに作成されます。オペレーションの状態(発生したエラーを含む)は、Operation リソースを使用してクエリできます。
Operations コレクションは、指定したプロジェクトに対して実行されたアクション(進行中のオペレーションを含む)の記録を提供します。オペレーションは直接作成されるのではなく、他のコレクションまたはリソースの呼び出しを通じて作成されます。
完了したオペレーションは削除され、オペレーション コレクションの一部として表示されなくなります。オペレーションは 30 日後にガベージ コレクションの対象になります。デフォルトでは、ListOperations は進行中のオペレーションと失敗したオペレーションのみを返します。完了したオペレーションを一覧表示するには、フィルタ done: true
を指定して ListOperations リクエストを発行します。
オペレーションはサービス FirestoreAdmin
によって作成されますが、サービス google.longrunning.Operations
を介してアクセスされます。
バックアップ スケジュールの作成 |
---|
データベースのバックアップ スケジュールを作成します。1 つのデータベースに構成できるバックアップ スケジュールは 2 つまでです。1 つの日次バックアップ スケジュールと 1 週間のバックアップ スケジュールを構成できます。
|
CreateDatabase |
---|
データベースを作成します。
|
CreateIndex |
---|
複合インデックスを作成します。これにより
|
DeleteBackup |
---|
バックアップを削除します。
|
DeleteBackupSchedule の削除 |
---|
バックアップ スケジュールを削除します。
|
データベースの削除 |
---|
データベースを削除します。
|
DeleteIndex |
---|
複合インデックスを削除します。
|
ExportDocuments |
---|
ドキュメントの全部または一部を Google Cloud Firestore から Google Cloud Storage などの別のストレージ システムにエクスポートします。ドキュメントの最近の更新はエクスポートに反映されない場合があります。エクスポートはバックグラウンドで行われ、作成されたオペレーション リソースを介して進行状況のモニタリングと管理を行うことができます。エクスポートの出力は、関連するオペレーションの完了後にのみ使用できます。エクスポート オペレーションが完了前にキャンセルされると、Google Cloud Storage に部分的なデータが残る可能性があります。 エクスポートの動作と出力形式について詳しくは、https://cloud.google.com/firestore/docs/manage-data/export-import をご覧ください。
|
GetBackup |
---|
バックアップに関する情報を取得します。
|
GetBackupSchedule |
---|
バックアップ スケジュールに関する情報を取得します。
|
GetDatabase |
---|
データベースに関する情報を取得します。
|
GetField |
---|
Field のメタデータと構成を取得します。
|
GetIndex |
---|
複合インデックスを取得します。
|
ImportDocuments |
---|
ドキュメントを Google Cloud Firestore にインポートします。同じ名前の既存のドキュメントは上書きされます。インポートはバックグラウンドで行われ、その進行状況は作成されたオペレーション リソースを介してモニタリングおよび管理できます。ImportDocuments オペレーションがキャンセルされた場合、データのサブセットがすでに Cloud Firestore にインポートされている可能性があります。
|
ListBackupSchedules |
---|
バックアップ スケジュールを一覧表示します。
|
ListBackups |
---|
すべてのバックアップを一覧表示します。
|
ListDatabases |
---|
プロジェクト内のすべてのデータベースを一覧表示します。
|
ListFields |
---|
このデータベースのフィールド構成とメタデータを一覧表示します。 現在、
|
ListIndexes |
---|
複合インデックスを一覧表示します。
|
データベースの復元 |
---|
既存のバックアップから復元して新しいデータベースを作成します。 新しいデータベースは、既存のバックアップと同じクラウド リージョンまたはマルチリージョン ロケーションに存在する必要があります。これは [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] と同様に動作します。ただし、新しい空のデータベースを作成するのではなく、データベースの種類、インデックス構成、既存のバックアップのドキュメントを使用して新しいデータベースを作成します。
|
UpdateBackupSchedule |
---|
バックアップ スケジュールを更新します。
|
UpdateDatabase |
---|
データベースを更新します。
|
UpdateField |
---|
フィールド構成を更新します。現在、フィールドの更新は単一フィールド インデックス構成にのみ適用されます。ただし、呼び出し元が認識していない構成の変更を避けるため、 この呼び出しは データベースのデフォルトのフィールド設定を構成するには、リソース名
|
バックアップ
Cloud Firestore データベースのバックアップ
バックアップには、特定の時点での、特定のデータベースのすべてのドキュメントとインデックス構成が含まれます。
フィールド | |
---|---|
name |
出力専用。バックアップの一意のリソース名。 形式は |
database |
出力専用。バックアップ元の Firestore データベースの名前。 形式は |
database_uid |
出力専用。バックアップ元の Firestore データベースのシステム生成 UUID4。 |
snapshot_time |
出力専用。現時点でバックアップには、外部整合性のあるデータベースのコピーが含まれています。 |
expire_time |
出力専用。このバックアップが期限切れになるタイムスタンプ。 |
state |
出力専用。バックアップの現在の状態。 |
状態
バックアップの現在の状態を示します。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
状態は指定されていません。 |
CREATING |
保留中のバックアップはまだ作成中です。この状態では、バックアップに対するオペレーションは拒否されます。 |
READY |
バックアップが完了し、使用できるようになりました。 |
NOT_AVAILABLE |
現在、バックアップをご利用いただけません。 |
BackupSchedule(バックアップスケジュール)
Cloud Firestore データベースのバックアップ スケジュール。
このリソースは、バックアップ対象のデータベースが所有しており、データベースとともに削除されます。ただし、実際のバックアップは実行されません。
フィールド | |
---|---|
name |
出力専用。指定されたプロジェクトのすべてのロケーションとデータベースにわたって一意のバックアップ スケジュール ID。 これは自動的に割り当てられます。 形式は |
create_time |
出力専用。このバックアップ スケジュールが作成されてから適用されるタイムスタンプ。 このスケジュールのバックアップは、この時間より前に作成されません。 |
update_time |
出力専用。このバックアップ スケジュールが最後に更新されたタイムスタンプ。バックアップ スケジュールが最初に作成されたときは、create_time と同じです。 |
retention |
バックアップを削除する必要があるのは、作成時刻と比較して将来の相対時刻(例: バックアップを 7 日間保持する)。 |
共用体フィールド recurrence 。バックアップが作成されるタイミングを表す oneof フィールド。recurrence は次のいずれかになります。 |
|
daily_recurrence |
毎日実行されるスケジュールの場合。 |
weekly_recurrence |
毎週特定の曜日に実行されるスケジュールの場合。 |
CreateBackupScheduleRequest
フィールド | |
---|---|
parent |
必須。親データベース。 形式: |
backup_schedule |
必須。作成するバックアップ スケジュール。 |
CreateDatabaseMetadata
この型にはフィールドがありません。
データベース作成オペレーションに関連するメタデータ。
CreateDatabaseRequest
FirestoreAdmin.CreateDatabase
のリクエスト。
フィールド | |
---|---|
parent |
必須。 |
database |
必須。作成するデータベース。 |
database_id |
必須。データベースに使用する ID。データベースのリソース名の最後のコンポーネントになります。 この値は 4 ~ 63 文字で指定してください。有効な文字は /[a-z][0-9]-/ で、先頭は英字、最後の文字は英字または数字です。/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ のような UUID にすることはできません。 「(default)」データベース ID も有効です。 |
CreateIndexRequest
FirestoreAdmin.CreateIndex
のリクエスト。
フィールド | |
---|---|
parent |
必須。 |
index |
必須。作成する複合インデックス。 |
毎日の繰り返し
この型にはフィールドがありません。
毎日実行される定期的なスケジュールを表します。
タイムゾーンは UTC です。
データベース
Cloud Firestore データベース。
フィールド | |
---|---|
name |
データベースのリソース名。形式: |
uid |
出力専用。このデータベースのシステム生成 UUID4。 |
create_time |
出力専用。このデータベースが作成された時点のタイムスタンプ。2016 年より前に作成されたデータベースでは create_time に値が入力されません。 |
update_time |
出力専用。このデータベースが最後に更新されたタイムスタンプ。これにはデータベース リソースの更新のみが含まれ、データベースに含まれるデータは含まれません。 |
delete_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 |
データベースの削除保護の状態。 |
cmek_config |
省略可。Presence は、このデータベースで CMEK が有効になっていることを示します。 |
previous_id |
出力専用。データベース リソースの以前のデータベース ID。このフィールドは、削除されたデータベースに対してのみ入力されます。 |
etag |
このチェックサムは、他のフィールドの値に基づいてサーバーによって計算され、処理を続行する前にクライアントが最新の値を持つことを確認するために、更新リクエストと削除リクエスト時に送信されます。 |
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 |
必須。このデータベースと同じロケーションにある鍵のみが暗号化に使用できます。 Firestore の nam5 マルチリージョンの場合、これは Cloud KMS マルチリージョン us に相当します。Firestore の eur3 マルチリージョンの場合、これは Cloud KMS マルチリージョン europe に対応します。https://cloud.google.com/kms/docs/locations をご覧ください。 正しい形式は |
active_key_version[] |
出力専用。現在使用中の KMS 鍵バージョン。鍵のローテーション中、使用中の鍵バージョンが複数存在する場合があります。 正しい形式は |
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 |
削除保護が有効になっています |
PointInTimeRecoveryEnablement
ポイントインタイム リカバリ機能の有効化
列挙型 | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
使用されません。 |
POINT_IN_TIME_RECOVERY_ENABLED |
読み取りは、過去 7 日間のデータの特定バージョンでサポートされています。
|
POINT_IN_TIME_RECOVERY_DISABLED |
読み取りは、過去 1 時間以内のデータのすべてのバージョンでサポートされています。 |
DeleteBackupRequest
FirestoreAdmin.DeleteBackup
のリクエスト。
フィールド | |
---|---|
name |
必須。削除するバックアップの名前。 形式は |
DeleteBackupScheduleRequest
[FirestoreAdmin.DeleteBackupSchedules][] のリクエスト。
フィールド | |
---|---|
name |
必須。バックアップ スケジュールの名前。 形式: |
DeleteDatabaseMetadata
この型にはフィールドがありません。
データベースの削除オペレーションに関連するメタデータ。
DeleteDatabaseRequest
FirestoreAdmin.DeleteDatabase
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
etag |
データベースの現在の ETag。etag が指定されていて、データベースの現在の etag と一致しない場合、削除はブロックされ、FAILED_PRECONDITION エラーが返されます。 |
DeleteIndexRequest
FirestoreAdmin.DeleteIndex
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
ExportDocumentsMetadata
FirestoreAdmin.ExportDocuments
からの結果 google.longrunning.Operation
のメタデータ。
フィールド | |
---|---|
start_time |
このオペレーションが開始した時刻。 |
end_time |
このオペレーションが完了した時刻。オペレーションが進行中の場合は設定されません。 |
operation_state |
エクスポート オペレーションの状態。 |
progress_documents |
このオペレーションの進行状況(ドキュメント単位)。 |
progress_bytes |
このオペレーションの進行状況(バイト単位)。 |
collection_ids[] |
エクスポートするコレクション ID。 |
output_uri_prefix |
ドキュメントのエクスポート先。 |
namespace_ids[] |
エクスポートされる名前空間 ID。 |
snapshot_time |
エクスポートされるデータベースのバージョンに対応するタイムスタンプ。指定しない場合、エクスポートされるドキュメントの整合性は保証されません。 |
ExportDocumentsRequest
FirestoreAdmin.ExportDocuments
のリクエスト。
フィールド | |
---|---|
name |
必須。エクスポートするデータベース。形式は |
collection_ids[] |
エクスポートするコレクション ID。指定しない場合は、すべてのコレクションになります。 |
output_uri_prefix |
出力 URI。現時点では、 |
namespace_ids[] |
空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。 空の文字列要素は、デフォルトの名前空間を表します。これは、データベースのデータがデフォルト以外の名前空間にあるものの、含めたくない場合に使用します。このリスト内の各名前空間は一意である必要があります。 |
snapshot_time |
エクスポートするデータベースのバージョンに対応するタイムスタンプ。タイムスタンプは過去の日付で、分に丸められ、 |
ExportDocumentsResponse
google.longrunning.Operation
レスポンス フィールドで返されます。
フィールド | |
---|---|
output_uri_prefix |
出力ファイルの場所。これにより、オペレーションが正常に完了した後に Cloud Firestore(このプロジェクトまたは別のプロジェクト)へのインポートを開始できます。 |
Field
データベース内の単一のフィールドを表します。
フィールドは「コレクション グループ」でグループ化されます。コレクション グループとは、データベース内の同じ 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 が詳細を示している可能性があります。 |
FieldOperationMetadata
FirestoreAdmin.UpdateField
からの結果 google.longrunning.Operation
のメタデータ。
フィールド | |
---|---|
start_time |
このオペレーションが開始した時刻。 |
end_time |
このオペレーションが完了した時刻。オペレーションが進行中の場合は設定されません。 |
field |
このオペレーションの対象となるフィールド リソース。例: |
index_config_deltas[] |
このオペレーションの意図を記述する |
state |
オペレーションの状態。 |
progress_documents |
このオペレーションの進行状況(ドキュメント単位)。 |
progress_bytes |
このオペレーションの進行状況(バイト単位)。 |
ttl_config_delta |
TTL 構成の差分を記述します。 |
IndexConfigDelta
インデックス構成の変更に関する情報。
フィールド | |
---|---|
change_type |
インデックスの変更方法を指定します。 |
index |
変更されるインデックス。 |
ChangeType
インデックスの変更方法を指定します。
列挙型 | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
変更の種類は特定されていないか、不明です。 |
ADD |
単一フィールド インデックスが追加されます。 |
REMOVE |
単一フィールド インデックスは削除されます。 |
ttlConfigDelta
TTL 構成の変更に関する情報。
フィールド | |
---|---|
change_type |
TTL 構成の変更方法を指定します。 |
ChangeType
TTL 構成の変更方法を指定します。
列挙型 | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
変更の種類は特定されていないか、不明です。 |
ADD |
TTL 構成を追加しています。 |
REMOVE |
TTL 構成は削除されます。 |
GetBackupRequest
FirestoreAdmin.GetBackup
のリクエスト。
フィールド | |
---|---|
name |
必須。取得するバックアップの名前。 形式は |
GetBackupScheduleRequest
FirestoreAdmin.GetBackupSchedule
のリクエスト。
フィールド | |
---|---|
name |
必須。バックアップ スケジュールの名前。 形式: |
GetDatabaseRequest
FirestoreAdmin.GetDatabase
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
GetFieldRequest
FirestoreAdmin.GetField
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
GetIndexRequest
FirestoreAdmin.GetIndex
のリクエスト。
フィールド | |
---|---|
name |
必須。 |
ImportDocumentsMetadata
FirestoreAdmin.ImportDocuments
からの結果 google.longrunning.Operation
のメタデータ。
フィールド | |
---|---|
start_time |
このオペレーションが開始した時刻。 |
end_time |
このオペレーションが完了した時刻。オペレーションが進行中の場合は設定されません。 |
operation_state |
インポート オペレーションの状態。 |
progress_documents |
このオペレーションの進行状況(ドキュメント単位)。 |
progress_bytes |
このオペレーションの進行状況(バイト単位)。 |
collection_ids[] |
インポートされるコレクション ID。 |
input_uri_prefix |
インポートされるドキュメントの場所。 |
namespace_ids[] |
インポートされる名前空間 ID。 |
ImportDocumentsRequest
FirestoreAdmin.ImportDocuments
のリクエスト。
フィールド | |
---|---|
name |
必須。インポート先のデータベース。形式は |
collection_ids[] |
インポートするコレクション ID。指定しない場合、インポートに含まれるすべてのコレクションが対象となります。 |
input_uri_prefix |
エクスポートされたファイルの場所。これは、正常に完了したエクスポートの ExportDocumentsResponse の output_uri_prefix と一致する必要があります。詳しくは、 |
namespace_ids[] |
空のリストはすべての名前空間を表します。これは、名前空間を使用しないデータベースに適しています。 空の文字列要素は、デフォルトの名前空間を表します。これは、データベースのデータがデフォルト以外の名前空間にあるものの、含めたくない場合に使用します。このリスト内の各名前空間は一意である必要があります。 |
索引
Cloud Firestore のインデックスを使用すると、データベース内のドキュメントに対して単純なクエリから複雑なクエリを行うことができます。
フィールド | |
---|---|
name |
出力専用。このインデックスに対してサーバーで定義された名前。複合インデックスの名前の形式は、 |
query_scope |
コレクション クエリのスコープが指定されたインデックスでは、特定のドキュメントの子であり、クエリ時に指定され、同じコレクション ID を持つコレクションに対してクエリを実行できます。 コレクション グループのクエリのスコープが指定されているインデックスでは、特定のドキュメントの子孫で、クエリ時に指定され、このインデックスと同じコレクション ID を持つすべてのコレクションに対してクエリを実行できます。 |
api_scope |
このインデックスでサポートされている API スコープ。 |
fields[] |
このインデックスでサポートされているフィールド。 複合インデックスの場合、フィールド数は 2 ~ 100 個です。最後のフィールド エントリは常にフィールドパス 単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールドパスと同じフィールドパスを持つ 1 つのエントリになります。 |
state |
出力専用。インデックスの提供状態。 |
ApiScope
API スコープでは、クエリでサポートされている API(Firestore ネイティブ、Datastore モードの Firestore)を定義します。
列挙型 | |
---|---|
ANY_API |
インデックスは Firestore Native Query API でのみ使用できます。グローバル ウィンドウはデフォルト。 |
DATASTORE_MODE_API |
インデックスは Datastore モードの Firestore クエリ API でのみ使用できます。 |
インデックス フィールド
インデックス内のフィールド。field_path は、どのフィールドにインデックスが付けられるかを示します。value_mode は、フィールド値がどのようにインデックス付けされるかを示します。
フィールド | |
---|---|
field_path |
name の場合もあります。単一フィールド インデックスの場合は、フィールド名と一致させるか、省略できます。 |
共用体フィールド value_mode 。フィールド値にインデックスを付ける方法。value_mode は次のいずれかになります。 |
|
order |
このフィールドが、指定された順序による並べ替え、または =、!=、<、<=、>、>= を使用した比較をサポートしていることを示します。 |
array_config |
このフィールドが |
vector_config |
このフィールドが、ベクトルに対する最近傍と距離の演算をサポートしていることを示します。 |
ArrayConfig
サポートされている配列値の構成。
列挙型 | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
インデックスでは、追加の配列クエリはサポートされていません。 |
CONTAINS |
このインデックスは、配列の包含クエリをサポートしています。 |
注文
サポートされている順序。
列挙型 | |
---|---|
ORDER_UNSPECIFIED |
順序は指定されていません。有効なオプションではありません。 |
ASCENDING |
フィールドはフィールド値の昇順で並べ替えられます。 |
DESCENDING |
フィールドは、フィールド値の降順で並べ替えられます。 |
VectorConfig
ベクトル検索オペレーションをサポートするためのインデックス構成
フィールド | |
---|---|
dimension |
必須。この構成が適用されるベクトルのディメンション。 結果として得られるインデックスには、この次元のベクトルのみが含まれ、同じ次元のベクトル検索に使用できます。 |
共用体フィールド 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 |
このオペレーションが開始した時刻。 |
end_time |
このオペレーションが完了した時刻。オペレーションが進行中の場合は設定されません。 |
index |
このオペレーションの対象となっているインデックス リソース。例: |
state |
オペレーションの状態。 |
progress_documents |
このオペレーションの進行状況(ドキュメント単位)。 |
progress_bytes |
このオペレーションの進行状況(バイト単位)。 |
ListBackupSchedulesRequest
フィールド | |
---|---|
parent |
必須。親データベース。 形式は |
ListBackupSchedulesResponse
FirestoreAdmin.ListBackupSchedules
に対するレスポンス。
フィールド | |
---|---|
backup_schedules[] |
すべてのバックアップ スケジュールのリスト。 |
ListBackupsRequest
FirestoreAdmin.ListBackups
のリクエスト。
フィールド | |
---|---|
parent |
必須。バックアップを一覧表示するロケーション。 形式は |
ListBackupsResponse
FirestoreAdmin.ListBackups
に対するレスポンス。
フィールド | |
---|---|
backups[] |
プロジェクトのすべてのバックアップのリスト。 |
unreachable[] |
既存のバックアップを取得できなかったロケーションのリスト。 このレスポンスでは、1 つのビジネスにアクセスできないときにリクエスト全体を失敗させるのではなく、部分的な結果セットと、ここでアクセスできないビジネスのリストが返されます。1 つの場所に対してリクエストを再試行すると、具体的なエラーが発生します。 |
ListDatabasesRequest
プロジェクトのすべてのロケーションにある Firestore データベースを一覧表示するリクエスト。
フィールド | |
---|---|
parent |
必須。 |
show_deleted |
true の場合、削除されたリソースも返されます。 |
ListDatabasesResponse
プロジェクトのデータベースのリスト。
フィールド | |
---|---|
databases[] |
プロジェクト内のデータベース。 |
unreachable[] |
個々のデータベースに関するデータをリストできない場合は、ここに記録されます。 エントリの例: projects/some_project/locations/some_location これは、データベースが存在する Cloud リージョンが現在利用できない場合に発生することがあります。この場合、データベースの詳細をすべて取得することはできません。リソースの「Get」リクエストまたは特定の場所に対する「List」リクエストを送信することで、より詳細なエラー メッセージを取得(または取得できる)できる場合があります。 |
ListFieldsRequest
FirestoreAdmin.ListFields
のリクエスト。
フィールド | |
---|---|
parent |
必須。 |
filter |
リストの結果に適用するフィルタ。現在、 |
page_size |
返される結果の数。 |
page_token |
前回の |
ListFieldsResponse
FirestoreAdmin.ListFields
に対するレスポンス。
フィールド | |
---|---|
fields[] |
リクエストされたフィールド。 |
next_page_token |
結果の別のページをリクエストするために使用できるページトークン。空白の場合は、これが最後のページです。 |
ListIndexesRequest
FirestoreAdmin.ListIndexes
のリクエスト。
フィールド | |
---|---|
parent |
必須。 |
filter |
リストの結果に適用するフィルタ。 |
page_size |
返される結果の数。 |
page_token |
前回の |
ListIndexesResponse
FirestoreAdmin.ListIndexes
に対するレスポンス。
フィールド | |
---|---|
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
オペレーションの進行状況を記述します。作業単位は汎用的であり、Progress
が使用される場所に基づいて解釈する必要があります。
フィールド | |
---|---|
estimated_work |
推定された作業量。 |
completed_work |
完了した作業の量。 |
RestoreDatabaseMetadata
[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] リクエストの long-running operation
のメタデータ。
フィールド | |
---|---|
start_time |
復元が開始された時刻。 |
end_time |
復元が終了した時刻。進行中の復元の場合は設定解除されます。 |
operation_state |
復元の処理状態。 |
database |
復元先のデータベースの名前。 |
backup |
復元元のバックアップの名前。 |
progress_percentage |
復元の進捗状況を示す残り時間の推定割合。 |
RestoreDatabaseRequest
[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] に対するリクエスト メッセージ。
フィールド | |
---|---|
parent |
必須。データベースを復元するプロジェクト。形式は |
database_id |
必須。データベースに使用する ID。データベースのリソース名の最後のコンポーネントになります。このデータベース ID を既存のデータベースに関連付けることはできません。 この値は 4 ~ 63 文字で指定してください。有効な文字は /[a-z][0-9]-/ で、先頭は英字、最後の文字は英字または数字です。/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ のような UUID にすることはできません。 「(default)」データベース ID も有効です。 |
共用体フィールド
|
|
backup |
復元元のバックアップ。親と同じプロジェクトからのものである必要があります。 形式: |
UpdateBackupScheduleRequest
フィールド | |
---|---|
backup_schedule |
必須。更新するバックアップ スケジュール。 |
update_mask |
更新するフィールドのリスト。 |
UpdateDatabaseMetadata
この型にはフィールドがありません。
データベース更新オペレーションに関連するメタデータ。
UpdateDatabaseRequest
FirestoreAdmin.UpdateDatabase
のリクエスト。
フィールド | |
---|---|
database |
必須。更新するデータベース。 |
update_mask |
更新するフィールドのリスト。 |
UpdateFieldRequest
FirestoreAdmin.UpdateField
のリクエスト。
フィールド | |
---|---|
field |
必須。更新するフィールド。 |
update_mask |
フィールドに対するマスク。指定すると、この field_mask で指定された構成のみがフィールドで更新されます。 |
毎週の繰り返し
指定した曜日に実行される定期的なスケジュールを表します。
タイムゾーンは UTC です。
フィールド | |
---|---|
day |
実行する曜日。 DAY_OF_WEEK_UNSPECIFIED は使用できません。 |