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 トランスコーディング構文を使用します。

パスパラメータ

パラメーター
parent

string

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

リクエストボディ

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

レスポンスボディ

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

認可範囲

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

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

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