You're seeing just the function firestore_projects_databases_collection_groups_fields_patch, go back to GoogleApi.Firestore.V1.Api.Projects module for more information.
Link to this function

firestore_projects_databases_collection_groups_fields_patch(connection, name, optional_params \\ [], opts \\ [])

View Source


) ::
  {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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


  • connection (type: GoogleApi.Firestore.V1.Connection.t) - Connection to server
  • name (type: String.t) - 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 mapvalue , e.g., 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)``represents a field, 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/{projectid}/databases/{database_id}/collectionGroups/__default/fields/*Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
    • :body (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field.t) -
  • opts (type: keyword()) - Call options


  • {:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}} on success
  • {:error, info} on failure