Method: projects.databases.collectionGroups.fields.patch

Atualiza uma configuração de campo. No momento, as atualizações de campo se aplicam apenas à configuração de índice de campo único. No entanto, as chamadas para FirestoreAdmin.UpdateField precisam fornecer uma máscara de campo para evitar a mudança de qualquer configuração desconhecida pelo autor da chamada. A máscara de campo precisa ser especificada como: { paths: "indexConfig" }.

Essa chamada retorna um google.longrunning.Operation que pode ser usado para acompanhar o status da atualização do campo. Os metadados da operação serão do tipo FieldOperationMetadata.

Para definir as configurações de campo padrão do banco de dados, use o Field especial com o nome do recurso: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Solicitação HTTP

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

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

Parâmetros de caminho

Parâmetros
field.name

string

Um nome de campo no formato projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Um caminho de campo pode ser um nome de campo simples, por exemplo , address ou um caminho para campos em mapValue (por exemplo, address.city) ou um caminho de campo especial. O único campo especial válido é *, que representa qualquer campo.

Os caminhos do campo podem ser citados usando (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]`, bem como caracteres ASCII.

Exemplos: (Observação: os comentários aqui estão escritos em sintaxe markdown, portanto há uma camada adicional de crases para representar um bloco de código) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, não qualquer campo.

Uma Field especial contém as configurações de indexação padrão para todos os campos. O nome do recurso deste campo é: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Os índices definidos neste Field serão aplicados a todos os campos que não têm a própria configuração de índice Field.

Parâmetros de consulta

Parâmetros
updateMask

string (FieldMask format)

Uma máscara relativa ao campo. Se especificado, somente a configuração especificada por essa field_mask será atualizada no campo.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da solicitação

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá 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.