Method: projects.databases.indexes.create

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

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

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

HTTP リクエスト

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

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

リクエスト本文

リクエストの本文には Index のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Operation のインスタンスが含まれます。

承認スコープ

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

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

詳細については、認証の概要をご覧ください。