alerts

package

v1.1.2 Latest Latest Go to latest Published: Aug 28, 2019 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cohesity/management-sdk-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

type ALERTS
type ALERTS_IMPL
- func NewALERTS(config configuration.CONFIGURATION) *ALERTS_IMPL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type ALERTS ¶

type ALERTS interface {
	GetAlertCategories() ([]*models.AlertCategoryName, error)

	GetNotificationRules() ([]*models.NotificationRule, error)

	CreateNotificationRule(*models.NotificationRule) (*models.NotificationRule, error)

	UpdateNotificationRule() (*models.NotificationRule, error)

	DeleteNotificationRule(int64) error

	GetResolutions(int64, []int64, []string, *int64, *int64, []string, *bool) ([]*models.AlertResolution, error)

	CreateResolution(*models.AlertResolutionRequest) (*models.AlertResolution, error)

	GetResolutionById(int64) (*models.AlertResolution, error)

	UpdateResolution(int64, *models.UpdateResolutionParams) (*models.AlertResolution, error)

	GetAlertTypes() ([]*models.AlertMetadata, error)

	GetAlerts(int64, []string, []int64, []models.AlertCategoryListGetAlertsEnum, *string, *string, *int64, *int64, []models.AlertStateListEnum, []models.AlertSeverityListEnum, []models.AlertTypeBucketListEnum, []int64, []string, *bool) ([]*models.Alert, error)

	GetAlertById(string) (*models.Alert, error)
}

* Interface for the ALERTS_IMPL

type ALERTS_IMPL ¶

type ALERTS_IMPL struct {
	// contains filtered or unexported fields
}

* Client structure as interface implementation

func NewALERTS ¶

func NewALERTS(config configuration.CONFIGURATION) *ALERTS_IMPL

* Factory for the ALERTS interaface returning ALERTS_IMPL

func (*ALERTS_IMPL) CreateNotificationRule ¶

func (me *ALERTS_IMPL) CreateNotificationRule(
	body *models.NotificationRule) (*models.NotificationRule, error)

*

Creates a new notification rule with provided delivery targets such as email
addresses and external apis.
@param *models.NotificationRule body parameter: Optional
@return Returns the *models.NotificationRule response from the API call

func (*ALERTS_IMPL) CreateResolution ¶

func (me *ALERTS_IMPL) CreateResolution(
	body *models.AlertResolutionRequest) (*models.AlertResolution, error)

*

Create an Alert Resolution and apply it to one or more Alerts.
Mark the Alerts as resolved.
@param *models.AlertResolutionRequest body parameter: Required
@return Returns the *models.AlertResolution response from the API call

func (*ALERTS_IMPL) DeleteNotificationRule ¶

func (me *ALERTS_IMPL) DeleteNotificationRule(
	ruleId int64) error

*

Deletes an existing alert notification rule matching the rule id.
@param int64 ruleId parameter: Required
@return Returns the response from the API call

func (*ALERTS_IMPL) GetAlertById ¶

func (me *ALERTS_IMPL) GetAlertById(
	id string) (*models.Alert, error)

*

Returns the Alert object corresponding to the specified id.
@param string id parameter: Required
@return Returns the *models.Alert response from the API call

func (*ALERTS_IMPL) GetAlertCategories ¶

func (me *ALERTS_IMPL) GetAlertCategories() ([]*models.AlertCategoryName, error)

*

Returns alert categories in Cohesity cluster.
@return Returns the []*models.AlertCategoryName response from the API call

func (*ALERTS_IMPL) GetAlertTypes ¶

func (me *ALERTS_IMPL) GetAlertTypes() ([]*models.AlertMetadata, error)

*

Returns registered alerts in the Cohesity cluster that match the filter
criteria specified using parameters. If no filter parameters are specified,
all registered alerts in the Cohesity cluster are returned.
@return Returns the []*models.AlertMetadata response from the API call

func (*ALERTS_IMPL) GetAlerts ¶

func (me *ALERTS_IMPL) GetAlerts(
	maxAlerts int64,
	alertIdList []string,
	alertTypeList []int64,
	alertCategoryList []models.AlertCategoryListGetAlertsEnum,
	propertyKey *string,
	propertyValue *string,
	startDateUsecs *int64,
	endDateUsecs *int64,
	alertStateList []models.AlertStateListEnum,
	alertSeverityList []models.AlertSeverityListEnum,
	alertTypeBucketList []models.AlertTypeBucketListEnum,
	resolutionIdList []int64,
	tenantIds []string,
	allUnderHierarchy *bool) ([]*models.Alert, error)

*

Returns all Alert objects found on the Cohesity Cluster that
match the filter criteria specified using parameters.
The Cohesity Cluster creates an Alert when a potential problem
is found or when a threshold has been exceeded on the Cohesity Cluster.
If no filter parameters are specified, all Alert objects are returned.
Each object provides details about the Alert such as the Status and Severity.
@param int64 maxAlerts parameter: Required
@param []string alertIdList parameter: Optional
@param []int64 alertTypeList parameter: Optional
@param []models.AlertCategoryListGetAlertsEnum alertCategoryList parameter: Optional
@param *string propertyKey parameter: Optional
@param *string propertyValue parameter: Optional
@param *int64 startDateUsecs parameter: Optional
@param *int64 endDateUsecs parameter: Optional
@param []models.AlertStateListEnum alertStateList parameter: Optional
@param []models.AlertSeverityListEnum alertSeverityList parameter: Optional
@param []models.AlertTypeBucketListEnum alertTypeBucketList parameter: Optional
@param []int64 resolutionIdList parameter: Optional
@param []string tenantIds parameter: Optional
@param *bool allUnderHierarchy parameter: Optional
@return Returns the []*models.Alert response from the API call

func (*ALERTS_IMPL) GetNotificationRules ¶

func (me *ALERTS_IMPL) GetNotificationRules() ([]*models.NotificationRule, error)

*

Gets all alert notification rules containing criteria to deliver notification
to delivery targets such as email addresses, invoking external apis etc.
@return Returns the []*models.NotificationRule response from the API call

func (*ALERTS_IMPL) GetResolutionById ¶

func (me *ALERTS_IMPL) GetResolutionById(
	id int64) (*models.AlertResolution, error)

*

Returns the Alert Resolution object corresponding to passed in Alert
Resolution Id.
@param int64 id parameter: Required
@return Returns the *models.AlertResolution response from the API call

func (*ALERTS_IMPL) GetResolutions ¶

func (me *ALERTS_IMPL) GetResolutions(
	maxResolutions int64,
	resolutionIdList []int64,
	alertIdList []string,
	startDateUsecs *int64,
	endDateUsecs *int64,
	tenantIds []string,
	allUnderHierarchy *bool) ([]*models.AlertResolution, error)

*

Returns all Alert Resolution objects found on the Cohesity Cluster
that match the filter criteria specified using parameters.
If no filter parameters are specified,
all Alert Resolution objects are returned.
Each object provides details about the Alert Resolution such as
the resolution summary and details.
@param int64 maxResolutions parameter: Required
@param []int64 resolutionIdList parameter: Optional
@param []string alertIdList parameter: Optional
@param *int64 startDateUsecs parameter: Optional
@param *int64 endDateUsecs parameter: Optional
@param []string tenantIds parameter: Optional
@param *bool allUnderHierarchy parameter: Optional
@return Returns the []*models.AlertResolution response from the API call

func (*ALERTS_IMPL) UpdateNotificationRule ¶

func (me *ALERTS_IMPL) UpdateNotificationRule() (*models.NotificationRule, error)

*

Updates delivery targets such as email addresses and external apis in an
existing notification rule.
@return Returns the *models.NotificationRule response from the API call

func (*ALERTS_IMPL) UpdateResolution ¶

func (me *ALERTS_IMPL) UpdateResolution(
	id int64,
	body *models.UpdateResolutionParams) (*models.AlertResolution, error)

*

Apply an existing Alert Resolution to one or more additional Alerts.
Mark those additional Alerts as resolved.
@param int64 id parameter: Required
@param *models.UpdateResolutionParams body parameter: Required
@return Returns the *models.AlertResolution response from the API call

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL