Method: projects.databases.collectionGroups.fields.patch

Atualiza uma configuração de campo. Atualmente, as atualizações de campo aplicam-se apenas à configuração de índice de campo único. No entanto, as chamadas para FirestoreAdmin.UpdateField devem fornecer uma máscara de campo para evitar a alteração de qualquer configuração da qual o chamador não tenha conhecimento. A máscara do campo deve ser especificada como: { paths: "indexConfig" } .

Esta chamada retorna um google.longrunning.Operation que pode ser usado para rastrear 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 para o banco de dados, use o Field especial com nome de recurso: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* .

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
field.name

string

Obrigatório. Um nome de campo do formulário 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 dentro de mapValue, por exemplo, address.city , ou um caminho de campo especial. O único campo especial válido é * , que representa qualquer campo.

Os caminhos dos campos 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 quaisquer caracteres simbólicos ascii.

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

Um 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 possuem sua 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 este field_mask será atualizada no campo.

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

Solicitar corpo

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

Corpo de resposta

Se for bem-sucedido, o corpo da resposta conterá uma instância de Operation .

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .