Method: projects.databases.collectionGroups.fields.patch

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

Esta llamada devuelve una google.longrunning.Operation que puede usarse para rastrear el estado de la actualización del campo. Los metadatos de la operación serán del tipo FieldOperationMetadata .

Para configurar los ajustes de campo predeterminados para la base de datos, utilice el Field especial con nombre de recurso: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* .

solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación gRPC .

Parámetros de ruta

Parámetros
field.name

string

Un nombre de campo del formulario projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

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

Las rutas de campo se pueden citar 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), [ , ]`, así como cualquier carácter simbólico ascii.

Ejemplos: (Nota: los comentarios aquí están escritos en sintaxis de rebajas, por lo que hay una capa adicional de comillas invertidas para representar un bloque de código) \ dirección.ciudad` represents a field named dirección.ciudad , not the map key in the field dirección . `*` represents a field named *`, no cualquier campo.

Un 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 índice Field .

Parámetros de consulta

Parámetros
updateMask

string ( FieldMask format)

Una máscara, relativa al campo. Si se especifica, solo se actualizará en el campo la configuración especificada por esta máscara de campo.

Esta es una lista separada por comas de nombres de campos completos. Ejemplo: "user.displayName,photo" .

Cuerpo de la solicitud

El cuerpo de la solicitud contiene una instancia de Field .

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene una instancia de Operation .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

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

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