Package google.firestore.admin.v1beta1

索引

Firestore管理者

Cloud Firestore 管理 API。

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

コンセプト

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

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

サービス

索引

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

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

メタデータ

Cloud Firestore のデータに関するメタデータと統計情報を提供します。この API の一部として提供されるデータは古い可能性があります。

手術

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

まだ実行されていない操作はキャンセルされる場合があります。キャンセルのリクエストは非同期であり、キャンセルのリクエストが行われた後も操作はしばらく実行され続ける可能性があります。

実行されたオペレーションは削除され、オペレーション コレクションの一部としてリストされなくなる場合があります。

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

インデックスの作成

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

指定されたインデックスを作成します。新しく作成されたインデックスの初期状態はCREATINGです。返されたgoogle.longrunning.Operationが完了すると、状態はREADYになります。インデックスがすでに存在する場合、呼び出しはALREADY_EXISTSステータスを返します。

作成中にプロセスでエラーが発生する可能性があり、その場合、インデックスはERROR状態に移行します。プロセスは、エラーの原因となったデータを修正し、 deleteでインデックスを削除し、 createでインデックスを再作成することで回復できます。

単一フィールドのインデックスは作成できません。

認可範囲

次の 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 に残る可能性があります。

認可範囲

次の 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 ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

指定されたフィルターに一致するインデックスをリストします。

認可範囲

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

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

CreateIndexRequest

FirestoreAdmin.CreateIndexのリクエスト。

田畑
parent

string

このインデックスが適用されるデータベースの名前。例: projects/{project_id}/databases/{database_id}

index

Index

作成するインデックス。名前フィールドと状態フィールドは出力のみであり、無視されます。特定の単一フィールドのインデックスは作成または削除できません。

インデックスの削除リクエスト

FirestoreAdmin.DeleteIndexのリクエスト。

田畑
name

string

インデックス名。例: projects/{project_id}/databases/{database_id}/indexes/{index_id}

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

ExportDocuments 操作のメタデータ。

田畑
start_time

Timestamp

操作の作業が開始された時刻。

end_time

Timestamp

操作が正常に終了したかどうかに関係なく終了した時刻。操作がまだアクティブな場合は設定を解除します。

operation_state

OperationState

エクスポート操作の状態。

progress_documents

Progress

処理されたドキュメントの数の推定。

progress_bytes

Progress

処理されたバイト数の推定値。

collection_ids[]

string

どのコレクション ID がエクスポートされているか。

output_uri_prefix

string

エンティティのエクスポート先。

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

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 がバケット (名前空間パスなし) の場合、開始時刻に基づいてプレフィックスが生成されます。

ドキュメントのエクスポート応答

google.longrunning.Operation応答フィールドで返されます。

田畑
output_uri_prefix

string

出力ファイルの場所。これを使用して、操作が正常に完了した後に Cloud Firestore (このプロジェクトまたは別のプロジェクト) へのインポートを開始できます。

GetIndexRequest

FirestoreAdmin.GetIndexのリクエスト。

田畑
name

string

インデックスの名前。例: projects/{project_id}/databases/{database_id}/indexes/{index_id}

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

ImportDocuments 操作のメタデータ。

田畑
start_time

Timestamp

操作の作業が開始された時刻。

end_time

Timestamp

操作が正常に終了したかどうかに関係なく終了した時刻。操作がまだアクティブな場合は設定を解除します。

operation_state

OperationState

インポート操作の状態。

progress_documents

Progress

処理されたドキュメントの数の推定。

progress_bytes

Progress

処理されたバイト数の推定値。

collection_ids[]

string

どのコレクション ID がインポートされているか。

input_uri_prefix

string

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

ドキュメントのインポートリクエスト

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.v1beta1.ExportDocumentsResponse.output_uri_prefix

索引

インデックス定義。

田畑
name

string

インデックスのリソース名。出力のみ。

collection_id

string

このインデックスが適用されるコレクション ID。必須。

fields[]

IndexField

インデックスを付けるフィールド。

state

State

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

インデックスの状態。インデックスの作成中、インデックスはCREATING状態になります。インデックスが正常に作成されると、 READY状態に遷移します。インデックスを作成できない場合は、 ERROR状態に遷移します。

列挙型
STATE_UNSPECIFIED状態は未指定です。
CREATINGインデックスは作成中です。インデックスに対してアクティブな長時間実行操作が存在します。インデックスはドキュメントの作成時に更新されます。インデックスデータが存在する場合があります。
READYインデックスを使用する準備ができました。インデックスはドキュメントの作成時に更新されます。インデックスは、適用されるすべての保存ドキュメントから完全に設定されます。
ERRORインデックスの作成中に問題が発生しました。インデックスに対してアクティブな長時間実行操作はなく、最後に終了した長時間実行操作は失敗しました。ドキュメントの作成時にインデックスは更新されません。インデックスデータが存在する場合があります。

インデックスフィールド

インデックスのフィールド。

田畑
field_path

string

畑の道。 [google.firestore.v1beta1.Document.fields][fields] で説明されているフィールド パス仕様と一致する必要があります。特別なフィールド パス__name__単独で使用することも、パスの末尾で使用することもできます。 __type__パスの末尾でのみ使用できます。

mode

Mode

フィールドのモード。

モード

モードによって、フィールドのインデックス付け方法が決まります。

列挙型
MODE_UNSPECIFIEDモードは指定されていません。
ASCENDINGフィールドの値には、昇順での順序付けと、<、>、<=、>=、および = によるクエリをサポートするためにインデックスが付けられます。
DESCENDINGフィールドの値には、降順での順序付けと、<、>、<=、>=、および = によるクエリをサポートするためにインデックスが付けられます。
ARRAY_CONTAINSフィールドの配列値には、ARRAY_CONTAINS クエリを使用したメンバーシップをサポートするためにインデックスが付けられます。

インデックス操作メタデータ

インデックス操作のメタデータ。このメタデータは、 google.longrunning.Operationのメタデータ フィールドに設定されます。

田畑
start_time

Timestamp

操作の作業が開始された時刻。

end_time

Timestamp

操作が正常に終了したかどうかに関係なく終了した時刻。操作がまだアクティブな場合は設定を解除します。

index

string

この操作が作用するインデックス リソース。例: projects/{project_id}/databases/{database_id}/indexes/{index_id}

operation_type

OperationType

インデックス操作のタイプ。

cancelled

bool

google.longrunning.Operationキャンセルされた場合は True。キャンセルが進行中の場合、cancel は true になりますが、 google.longrunning.Operation.done false になります。

document_progress

Progress

既存の操作の進捗状況。ドキュメントの数で測定されます。

操作タイプ

インデックス操作のタイプ。

列挙型
OPERATION_TYPE_UNSPECIFIED不特定。サーバーによって設定されることはありません。
CREATING_INDEX操作はインデックスを作成しています。 CreateIndex呼び出しによって開始されます。

ListIndexesRequest

FirestoreAdmin.ListIndexesのリクエスト。

田畑
parent

string

データベース名。例: projects/{project_id}/databases/{database_id}

filter

string

page_size

int32

標準のリスト ページ サイズ。

page_token

string

標準のリスト ページ トークン。

ListIndexesResponse

FirestoreAdmin.ListIndexesの応答。

田畑
indexes[]

Index

インデックス。

next_page_token

string

標準のリストの次ページ トークン。

位置メタデータ

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

google.cloud.location.Location.metadataのメタデータ メッセージ。

動作状態

進行中のオペレーションで考えられるさまざまな状態。

列挙型
STATE_UNSPECIFIED不特定。
INITIALIZINGリクエストは処理の準備中です。
PROCESSINGリクエストはアクティブに処理されています。
CANCELLINGユーザーが操作に対して google.longrunning.Operations.CancelOperation を呼び出した後、リクエストはキャンセル処理中です。
FINALIZINGリクエストは処理され、最終段階にあります。
SUCCESSFULリクエストは正常に完了しました。
FAILEDリクエストの処理は終了しましたが、エラーが発生しました。
CANCELLEDユーザーが google.longrunning.Operations.CancelOperation を呼び出した後、リクエストのキャンセルが完了しました。

進捗

特定のメトリクスの進捗状況を測定します。

田畑
work_completed

int64

完了した作業量の見積もり。これはwork_estimatedよりも大きくなる可能性があることに注意してください。

work_estimated

int64

実行する必要がある作業量の見積もり。作業見積もりが入手できない場合はゼロ。作業の進行に応じて変更される場合があります。