GoogleApi.AlertCenter.V1beta1.Api.Alerts.alertcenter_alerts_list

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

alertcenter_alerts_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

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

Lists the alerts.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server
  • 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 alerts are associated with. Inferred from the caller identity if not provided.
    • :filter (type: String.t) - Optional. A query string for filtering alert results. For more details, see Query filters and Supported query filter fields.
    • :orderBy (type: String.t) - Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using order_by="create_time desc". Currently, supported sorting are create_time asc, create_time desc, update_time desc
    • :pageSize (type: integer()) - Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
    • :pageToken (type: String.t) - Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
  • opts (type: keyword()) - Call options

Returns

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