Method: googleapis.firestore.v1beta2.projects.databases.collectionGroups.fields.patch

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/*.

This method waits—the workflow execution is paused—until the operation is complete, fails, or times out. The default timeout value is 1800 seconds (30 minutes) and can be changed to a maximum value of 31536000 seconds (one year) for long-running operations using the connector_params field. See the Connectors reference.

The connector uses polling to monitor the long-running operation, which might generate additional billable steps. For more information about retries and long-running operations, refer to Understand connectors.

The polling policy for the long-running operation can be configured. To set the connector-specific parameters (connector_params), refer to Invoke a connector call.

Arguments

Parameters
name

string

Required. A field name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} A field path may be a simple field name, e.g. address or a path to fields within map_value , e.g. address.city, or a special field path. The only valid special field is *, which represents any field. Field paths may be quoted using (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 well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.``represents a field named, not any field. A specialFieldcontains the default indexing settings for all fields. This field's resource name is:projects/{project_id}/databases/{database_id}/collectionGroups/default/fields/Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.
updateMask

string (FieldMask format)

A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
body

object (GoogleFirestoreAdminV1beta2Field)

Required.

Raised exceptions

Exceptions
ConnectionError In case of a network problem (such as DNS failure or refused connection).
HttpError If the response status is >= 400 (excluding 429 and 503).
TimeoutError If a long-running operation takes longer to finish than the specified timeout limit.
TypeError If an operation or function receives an argument of the wrong type.
ValueError If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
OperationError If the long-running operation finished unsuccessfully.
ResponseTypeError If the long-running operation returned a response of the wrong type.

Response

If successful, the response contains an instance of GoogleLongrunningOperation.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- patch:
    call: googleapis.firestore.v1beta2.projects.databases.collectionGroups.fields.patch
    args:
        name: ...
        updateMask: ...
        body:
            indexConfig:
                indexes: ...
            name: ...
    result: patchResult

JSON

[
  {
    "patch": {
      "call": "googleapis.firestore.v1beta2.projects.databases.collectionGroups.fields.patch",
      "args": {
        "name": "...",
        "updateMask": "...",
        "body": {
          "indexConfig": {
            "indexes": "..."
          },
          "name": "..."
        }
      },
      "result": "patchResult"
    }
  }
]