GoogleApi.Firestore.V1.Api.Projects.firestore_projects_databases_collection_groups_indexes_create

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

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

View Source

Specs

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

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

Parameters

  • connection (type: GoogleApi.Firestore.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_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.V1.Model.GoogleFirestoreAdminV1Index.t) -
  • opts (type: keyword()) - Call options

Returns

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