projects.databases.collectionGroups.fields.patch: Updates a field configuration. Currently, field updates apply...

In robonomist/googleFirestore: Cloud Firestore API

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: 'index_config' }. 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Description

Autogenerated via gar_create_api_skeleton

Usage

projects.databases.collectionGroups.fields.patch(
  GoogleFirestoreAdminV1Field,
  name,
  updateMask = NULL
)

Arguments

GoogleFirestoreAdminV1Field	The GoogleFirestoreAdminV1Field object to pass to this method
name	Required
updateMask	A mask, relative to the field

Details

Authentication scopes used by this function are:

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

• https://www.googleapis.com/auth/datastore

Set options(googleAuthR.scopes.selected = c(https://www.googleapis.com/auth/cloud-platform, https://www.googleapis.com/auth/datastore) Then run googleAuthR::gar_auth() to authenticate. See gar_auth for details.

See Also

Google Documentation

Other GoogleFirestoreAdminV1Field functions: GoogleFirestoreAdminV1Field()

robonomist/googleFirestore documentation built on Jan. 30, 2023, 6:39 p.m.