GoogleApi.AlertCenter.V1beta1.Api.Alerts.alertcenter_alerts_delete

You're seeing just the function alertcenter_alerts_delete, go back to GoogleApi.AlertCenter.V1beta1.Api.Alerts module for more information.
Link to this function

alertcenter_alerts_delete(connection, alert_id, optional_params \\ [], opts \\ [])

View Source

Specs

alertcenter_alerts_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.AlertCenter.V1beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Marks the specified alert for deletion. An alert that has been marked for deletion is removed from Alert Center after 30 days. Marking an alert for deletion has no effect on an alert which has already been marked for deletion. Attempting to mark a nonexistent alert for deletion results in a NOT_FOUND error.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server
  • alert_id (type: String.t) - Required. The identifier of the alert to delete.
  • 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").
    • :customerId (type: String.t) - Optional. The unique identifier of the Google Workspace organization account of the customer the alert is associated with. Inferred from the caller identity if not provided.
  • opts (type: keyword()) - Call options

Returns

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