Documentation
¶
Overview ¶
Package individualalerts contains methods related to IndividualAlerts
Index ¶
- type IndividualAlertsV1
- func (i *IndividualAlertsV1) ListIndividualAlerts(limit *int64, start *string, sort *string, filter *string, embed *string) (*models.ListAlertsResponse, *apiutils.APIError)
- func (i *IndividualAlertsV1) ReadIndividualAlert(individualAlertId string, embed *string) (*models.ReadAlertResponse, *apiutils.APIError)
- func (i *IndividualAlertsV1) UpdateIndividualAlert(individualAlertId string, embed *string, ...) (*models.UpdateAlertResponse, *apiutils.APIError)
- type IndividualAlertsV1Client
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type IndividualAlertsV1 ¶
type IndividualAlertsV1 struct {
// contains filtered or unexported fields
}
IndividualAlertsV1 represents a custom type struct
func (*IndividualAlertsV1) ListIndividualAlerts ¶
func (i *IndividualAlertsV1) ListIndividualAlerts( limit *int64, start *string, sort *string, filter *string, embed *string) ( *models.ListAlertsResponse, *apiutils.APIError)
ListIndividualAlerts Returns a list of individual alerts.
Each alert is associated with a cause, which represents the issue that generated the alert, and each cause belongs to a general alert alert type. Some alert types may be associated with multiple causes.
The following table lists the Clumio alert types:
+--------------------------+---------------------------------------------------+ | Alert Type | Description | +==========================+===================================================+ | policy_violated | An entity's scheduled backup failed. | +--------------------------+---------------------------------------------------+ | restore_failed | An entity restore failed. | +--------------------------+---------------------------------------------------+ | file_restore_failed | A file restore failed. | +--------------------------+---------------------------------------------------+ | tag_conflict | An EBS volume has multiple associated tags | | | with different protection policies applied at the | | | tag level. | +--------------------------+---------------------------------------------------+ | aws_account_disconnected | The connection | | | between Clumio Cloud Connector and the user's AWS | | | account failed. | +--------------------------+---------------------------------------------------+ | enc_key_inaccessible | An issue is blocking encryption key access. | +--------------------------+---------------------------------------------------+
func (*IndividualAlertsV1) ReadIndividualAlert ¶
func (i *IndividualAlertsV1) ReadIndividualAlert( individualAlertId string, embed *string) ( *models.ReadAlertResponse, *apiutils.APIError)
ReadIndividualAlert Returns a representation of the specified individual alert.
func (*IndividualAlertsV1) UpdateIndividualAlert ¶
func (i *IndividualAlertsV1) UpdateIndividualAlert( individualAlertId string, embed *string, body *models.UpdateIndividualAlertV1Request) ( *models.UpdateAlertResponse, *apiutils.APIError)
UpdateIndividualAlert Manages an existing individual alert. Managing an individual alert includes clearing the alert and adding notes to the specified alert.
type IndividualAlertsV1Client ¶
type IndividualAlertsV1Client interface {
// Returns a list of individual alerts.
//
// Each alert is associated with a cause, which represents the issue that generated the alert,
// and each cause belongs to a general alert alert type. Some alert types may be associated with multiple causes.
//
// The following table lists the Clumio alert types:
//
//
// +--------------------------+---------------------------------------------------+
// | Alert Type | Description |
// +==========================+===================================================+
// | policy_violated | An entity's scheduled backup failed. |
// +--------------------------+---------------------------------------------------+
// | restore_failed | An entity restore failed. |
// +--------------------------+---------------------------------------------------+
// | file_restore_failed | A file restore failed. |
// +--------------------------+---------------------------------------------------+
// | tag_conflict | An EBS volume has multiple associated tags |
// | | with different protection policies applied at the |
// | | tag level. |
// +--------------------------+---------------------------------------------------+
// | aws_account_disconnected | The connection |
// | | between Clumio Cloud Connector and the user's AWS |
// | | account failed. |
// +--------------------------+---------------------------------------------------+
// | enc_key_inaccessible | An issue is blocking encryption key access. |
// +--------------------------+---------------------------------------------------+
//
ListIndividualAlerts(
limit *int64,
start *string,
sort *string,
filter *string,
embed *string) (
*models.ListAlertsResponse, *apiutils.APIError)
// Returns a representation of the specified individual alert.
ReadIndividualAlert(
individualAlertId string,
embed *string) (
*models.ReadAlertResponse, *apiutils.APIError)
// Manages an existing individual alert. Managing an individual alert includes clearing the alert and adding notes to the specified alert.
UpdateIndividualAlert(
individualAlertId string,
embed *string,
body *models.UpdateIndividualAlertV1Request) (
*models.UpdateAlertResponse, *apiutils.APIError)
}
IndividualAlertsV1Client represents a custom type interface
func NewIndividualAlertsV1 ¶
func NewIndividualAlertsV1(config config.Config) IndividualAlertsV1Client
NewIndividualAlertsV1 returns IndividualAlertsV1Client
Source Files