GoogleApi.AlertCenter.V1beta1.Api.Alerts (google_api_alert_center v0.15.2) View Source

API calls for all endpoints tagged Alerts.

Link to this section Summary

Functions

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.

Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns NOT_FOUND error. Attempting to create a feedback for an alert that is marked for deletion returns FAILED_PRECONDITION' error. ## Parameters *connection(*type:*GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server *alert_id(*type:*String.t) - Required. The identifier of the alert this feedback belongs to. *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. *:body(*type:*GoogleApi.AlertCenter.V1beta1.Model.AlertFeedback.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure

Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns NOT_FOUND error.

Gets the specified alert. Attempting to get a nonexistent alert returns NOT_FOUND error.

Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns NOT_FOUND error.

Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a NOT_FOUND error. Attempting to undelete an alert which has not been marked for deletion has no effect.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Performs batch delete operation on 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").
    • :body (type: GoogleApi.AlertCenter.V1beta1.Model.BatchDeleteAlertsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.BatchDeleteAlertsResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Performs batch undelete operation on 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").
    • :body (type: GoogleApi.AlertCenter.V1beta1.Model.BatchUndeleteAlertsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.BatchUndeleteAlertsResponse{}} on success
  • {:error, info} on failure
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
Link to this function

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

View Source

Specs

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

Creates new feedback for an alert. Attempting to create a feedback for a non-existent alert returns NOT_FOUND error. Attempting to create a feedback for an alert that is marked for deletion returns FAILED_PRECONDITION' error. ## Parameters *connection(*type:*GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server *alert_id(*type:*String.t) - Required. The identifier of the alert this feedback belongs to. *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. *:body(*type:*GoogleApi.AlertCenter.V1beta1.Model.AlertFeedback.t) - *opts(*type:*keyword()) - Call options ## Returns *}on success *` on failure

Link to this function

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

View Source

Specs

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

Lists all the feedback for an alert. Attempting to list feedbacks for a non-existent alert returns NOT_FOUND error.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server
  • alert_id (type: String.t) - Required. The alert identifier. The "-" wildcard could be used to represent all alerts.
  • 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 feedback are associated with. Inferred from the caller identity if not provided.
    • :filter (type: String.t) - Optional. A query string for filtering alert feedback results. For more details, see Query filters and Supported query filter fields.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.ListAlertFeedbackResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Gets the specified alert. Attempting to get a nonexistent alert returns 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 retrieve.
  • 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.Alert{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Specs

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

Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns 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 this metadata belongs to.
  • 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 metadata is associated with. Inferred from the caller identity if not provided.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AlertCenter.V1beta1.Model.AlertMetadata{}} on success
  • {:error, info} on failure
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
Link to this function

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

View Source

Specs

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

Restores, or "undeletes", an alert that was marked for deletion within the past 30 days. Attempting to undelete an alert which was marked for deletion over 30 days ago (which has been removed from the Alert Center database) or a nonexistent alert returns a NOT_FOUND error. Attempting to undelete an alert which has not been marked for deletion has no effect.

Parameters

  • connection (type: GoogleApi.AlertCenter.V1beta1.Connection.t) - Connection to server
  • alert_id (type: String.t) - Required. The identifier of the alert to undelete.
  • 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.AlertCenter.V1beta1.Model.UndeleteAlertRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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