Met à jour une configuration de champ. Actuellement, les mises à jour de champs s'appliquent uniquement à la configuration d'index à champ unique. Cependant, les appels à FirestoreAdmin.UpdateField
doivent fournir un masque de champ pour éviter de modifier une configuration dont l'appelant n'est pas conscient. Le masque de champ doit être spécifié comme : { paths: "indexConfig" }
.
Cet appel renvoie une google.longrunning.Operation
qui peut être utilisée pour suivre l'état de la mise à jour du champ. Les métadonnées de l'opération seront du type FieldOperationMetadata
.
Pour configurer les paramètres de champ par défaut de la base de données, utilisez le Field
spécial avec le nom de la ressource : projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
Requête HTTP
PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
L'URL utilise la syntaxe de transcodage gRPC .
Paramètres du chemin
Paramètres | |
---|---|
field.name | Requis. Un nom de champ du Un chemin de champ peut être un simple nom de champ, par exemple Les chemins de champ peuvent être cités en utilisant Exemples : (Remarque : les commentaires ici sont écrits dans une syntaxe markdown, il y a donc une couche supplémentaire de backticks pour représenter un bloc de code) Un |
Paramètres de requête
Paramètres | |
---|---|
updateMask | Un masque, relatif au champ. Si spécifié, seule la configuration spécifiée par ce field_mask sera mise à jour dans le champ. Il s'agit d'une liste de noms de champs entièrement qualifiés, séparés par des virgules. Exemple : |
Corps de la demande
Le corps de la requête contient une instance de Field
.
Corps de réponse
En cas de succès, le corps de la réponse contient une instance de Operation
.
Portées des autorisations
Nécessite l'une des étendues OAuth suivantes :
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
Pour plus d'informations, consultez la Présentation de l'authentification .