consolidatedalerts

Documentation

Overview

Package consolidatedalerts contains methods related to ConsolidatedAlerts

Index

• type ConsolidatedAlertsV1
  • func (c *ConsolidatedAlertsV1) ListConsolidatedAlerts(limit *int64, start *string, filter *string) (*models.ListConsolidatedAlertsResponse, *apiutils.APIError)
  • func (c *ConsolidatedAlertsV1) ReadConsolidatedAlert(id string) (*models.ReadConsolidatedAlertResponse, *apiutils.APIError)
  • func (c *ConsolidatedAlertsV1) UpdateConsolidatedAlert(id string, body *models.UpdateConsolidatedAlertV1Request) (*models.UpdateConsolidatedAlertResponse, *apiutils.APIError)
• type ConsolidatedAlertsV1Client
  • func NewConsolidatedAlertsV1(config config.Config) ConsolidatedAlertsV1Client

Types

type ConsolidatedAlertsV1

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

ConsolidatedAlertsV1 represents a custom type struct

func (*ConsolidatedAlertsV1) ListConsolidatedAlerts

func (c *ConsolidatedAlertsV1) ListConsolidatedAlerts(
	limit *int64,
	start *string,
	filter *string) (
	*models.ListConsolidatedAlertsResponse, *apiutils.APIError)

ListConsolidatedAlerts Returns a list of consolidated alerts.

func (*ConsolidatedAlertsV1) ReadConsolidatedAlert

func (c *ConsolidatedAlertsV1) ReadConsolidatedAlert(
	id string) (
	*models.ReadConsolidatedAlertResponse, *apiutils.APIError)

ReadConsolidatedAlert Returns a representation of the specified consolidated alert.

func (*ConsolidatedAlertsV1) UpdateConsolidatedAlert

func (c *ConsolidatedAlertsV1) UpdateConsolidatedAlert(
	id string,
	body *models.UpdateConsolidatedAlertV1Request) (
	*models.UpdateConsolidatedAlertResponse, *apiutils.APIError)

UpdateConsolidatedAlert Manages the specified consolidated alert. Managing a consolidated alert includes clearing the alert and adding notes to the specified consolidated alert.

type ConsolidatedAlertsV1Client

type ConsolidatedAlertsV1Client interface {
	// ListConsolidatedAlerts Returns a list of consolidated alerts.
	ListConsolidatedAlerts(
		limit *int64,
		start *string,
		filter *string) (
		*models.ListConsolidatedAlertsResponse, *apiutils.APIError)

	// ReadConsolidatedAlert Returns a representation of the specified consolidated alert.
	ReadConsolidatedAlert(
		id string) (
		*models.ReadConsolidatedAlertResponse, *apiutils.APIError)

	// UpdateConsolidatedAlert Manages the specified consolidated alert. Managing a consolidated alert includes clearing the alert and adding notes to the specified consolidated alert.
	UpdateConsolidatedAlert(
		id string,
		body *models.UpdateConsolidatedAlertV1Request) (
		*models.UpdateConsolidatedAlertResponse, *apiutils.APIError)
}

ConsolidatedAlertsV1Client represents a custom type interface

func NewConsolidatedAlertsV1

func NewConsolidatedAlertsV1(config config.Config) ConsolidatedAlertsV1Client

NewConsolidatedAlertsV1 returns ConsolidatedAlertsV1Client