Method: projects.databases.collectionGroups.fields.patch

Actualiza la configuración de un campo. Actualmente, las actualizaciones de campos se aplican solo a la configuración de índices de campo único. Sin embargo, las llamadas a FirestoreAdmin.UpdateField deben proporcionar una máscara de campo para evitar cambiar cualquier configuración que el llamador no conozca. La máscara de campo debe especificarse de la siguiente manera: { paths: "indexConfig" }.

Esta llamada muestra un google.longrunning.Operation que se puede usar para realizar un seguimiento del estado de la actualización del campo. Los metadatos de la operación serán del tipo FieldOperationMetadata.

Para establecer la configuración de campo predeterminada para la base de datos, usa el Field especial con el nombre del recurso: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
field.name

string

Obligatorio. Un nombre de campo con el formato projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

La ruta de un campo puede ser un nombre simple de campo, p.ej., address, o una ruta de acceso a campos dentro de mapValue, p.ej., address.city, o una ruta de acceso de un campo especial. El único campo especial válido es *, que representa cualquier campo.

Las rutas de los campos se pueden usar con (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),[,]`, así como cualquier carácter simbólico ASCII.

Ejemplos:\represents a field namedrepresents a field named, not the map key in the field.

Una Field especial contiene la configuración de indexación predeterminada para todos los campos. El nombre del recurso de este campo es projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*. Los índices definidos en este Field se aplicarán a todos los campos que no tengan su propia configuración de índices de Field.

Parámetros de consulta

Parámetros
updateMask

string (FieldMask format)

Una máscara, en relación con el campo. Si se especifica, solo se actualizará la configuración especificada por esta field_mask en el campo.

Se trata de una lista separada por comas de los nombres de campos completamente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la solicitud

El cuerpo de la solicitud incluye una instancia de Field.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

Para obtener más información, consulta Descripción general de la autenticación.