Method: projects.databases.indexes.create

Cria o índice especificado. O estado inicial de um índice recém-criado é CREATING. Quando o google.longrunning.Operation retornado for concluído, o estado será READY. Se o índice já existir, a chamada retornará um status ALREADY_EXISTS.

Durante a criação, o processo pode resultar em um erro. Nesse caso, o índice será movido para o estado ERROR. Para recuperar o processo, corrija os dados que causaram o erro, removendo o índice com delete e recriando o índice com create.

Não é possível criar índices com um único campo.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O nome do banco de dados ao qual este índice será aplicado. Exemplo: projects/{projectId}/databases/{databaseId}

Corpo da solicitação

O corpo da solicitação contém uma instância de Index.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.