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

firestore_projects_databases_indexes_create(connection, parent, optional_params \\ [], opts \\ [])

View Source


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

Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.


  • connection (type: GoogleApi.Firestore.V1beta1.Connection.t) - Connection to server
  • parent (type: String.t) - The name of the database this index will apply to. For example: projects/{project_id}/databases/{database_id}
  • 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").
    • :body (type: GoogleApi.Firestore.V1beta1.Model.GoogleFirestoreAdminV1beta1Index.t) -
  • opts (type: keyword()) - Call options


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