Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to FirestoreAdmin.UpdateField
should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: { paths: "indexConfig" }
.
This call returns a google.longrunning.Operation
which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata
.
To configure the default field settings for the database, use the special Field
with resource name: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
HTTP request
PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
field.name |
Required. A field name of the form A field path may be a simple field name, e.g. Field paths may be quoted using Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) A special |
Query parameters
Parameters | |
---|---|
updateMask |
A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field. This is a comma-separated list of fully qualified names of fields. Example: |
Request body
The request body contains an instance of Field
.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.