Versions in this module Expand all Collapse all v1 v1.4.0 Oct 4, 2023 Changes in this version + func ValidatePriority(priority Priority) error + type AcknowledgeAlertRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *AcknowledgeAlertRequest) Method() string + func (r *AcknowledgeAlertRequest) RequestParams() map[string]string + func (r *AcknowledgeAlertRequest) ResourcePath() string + func (r *AcknowledgeAlertRequest) Validate() error + type AddDetailsRequest struct + Details map[string]string + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *AddDetailsRequest) Method() string + func (r *AddDetailsRequest) RequestParams() map[string]string + func (r *AddDetailsRequest) ResourcePath() string + func (r *AddDetailsRequest) Validate() error + type AddNoteRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *AddNoteRequest) Method() string + func (r *AddNoteRequest) RequestParams() map[string]string + func (r *AddNoteRequest) ResourcePath() string + func (r *AddNoteRequest) Validate() error + type AddResponderRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Responder Responder + Source string + User string + func (r *AddResponderRequest) Method() string + func (r *AddResponderRequest) RequestParams() map[string]string + func (r *AddResponderRequest) ResourcePath() string + func (r *AddResponderRequest) Validate() error + type AddTagsRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + Tags []string + User string + func (r *AddTagsRequest) Method() string + func (r *AddTagsRequest) RequestParams() map[string]string + func (r *AddTagsRequest) ResourcePath() string + func (r *AddTagsRequest) Validate() error + type AddTeamRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + Team Team + User string + func (r *AddTeamRequest) Method() string + func (r *AddTeamRequest) RequestParams() map[string]string + func (r *AddTeamRequest) ResourcePath() string + func (r *AddTeamRequest) Validate() error + type Alert struct + Acknowledged bool + Alias string + Count int + CreatedAt time.Time + Id string + Integration Integration + IsSeen bool + LastOccurredAt time.Time + Message string + Owner string + OwnerTeamID string + Priority Priority + Report Report + Responders []Responder + Seen bool + Snoozed bool + SnoozedUntil time.Time + Source string + Status string + Tags []string + TinyID string + UpdatedAt time.Time + type AlertIdentifier uint32 + const ALERTID + const ALIAS + const TINYID + type AlertLog struct + CreatedAt time.Time + Log string + Offset string + Owner string + Type string + type AlertNote struct + CreatedAt time.Time + Note string + Offset string + Owner string + type AlertRecipient struct + CreatedAt time.Time + Method string + State string + UpdatedAt time.Time + User User + type AssignRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Owner User + Source string + User string + func (r *AssignRequest) Method() string + func (r *AssignRequest) RequestParams() map[string]string + func (r *AssignRequest) ResourcePath() string + func (r *AssignRequest) Validate() error + type AsyncAlertResult struct + Result string + func (ar *AsyncAlertResult) RetrieveStatus(ctx context.Context) (*RequestStatusResult, error) + type Client struct + func NewClient(config *client.Config) (*Client, error) + func (c *Client) Acknowledge(ctx context.Context, req *AcknowledgeAlertRequest) (*AsyncAlertResult, error) + func (c *Client) AddDetails(ctx context.Context, req *AddDetailsRequest) (*AsyncAlertResult, error) + func (c *Client) AddNote(ctx context.Context, req *AddNoteRequest) (*AsyncAlertResult, error) + func (c *Client) AddResponder(ctx context.Context, req *AddResponderRequest) (*AsyncAlertResult, error) + func (c *Client) AddTags(ctx context.Context, req *AddTagsRequest) (*AsyncAlertResult, error) + func (c *Client) AddTeam(ctx context.Context, req *AddTeamRequest) (*AsyncAlertResult, error) + func (c *Client) AssignAlert(ctx context.Context, req *AssignRequest) (*AsyncAlertResult, error) + func (c *Client) Close(ctx context.Context, req *CloseAlertRequest) (*AsyncAlertResult, error) + func (c *Client) CountAlerts(ctx context.Context, req *CountAlertsRequest) (*CountAlertResult, error) + func (c *Client) Create(ctx context.Context, req *CreateAlertRequest) (*AsyncAlertResult, error) + func (c *Client) CreateAlertAttachments(ctx context.Context, req *CreateAlertAttachmentRequest) (*CreateAlertAttachmentsResult, error) + func (c *Client) CreateSavedSearch(ctx context.Context, req *CreateSavedSearchRequest) (*SavedSearchResult, error) + func (c *Client) Delete(ctx context.Context, req *DeleteAlertRequest) (*AsyncAlertResult, error) + func (c *Client) DeleteAlertAttachment(ctx context.Context, req *DeleteAttachmentRequest) (*DeleteAlertAttachmentResult, error) + func (c *Client) DeleteSavedSearch(ctx context.Context, req *DeleteSavedSearchRequest) (*AsyncAlertResult, error) + func (c *Client) EscalateToNext(ctx context.Context, req *EscalateToNextRequest) (*AsyncAlertResult, error) + func (c *Client) ExecuteCustomAction(ctx context.Context, req *ExecuteCustomActionAlertRequest) (*AsyncAlertResult, error) + func (c *Client) Get(ctx context.Context, req *GetAlertRequest) (*GetAlertResult, error) + func (c *Client) GetAlertAttachment(ctx context.Context, req *GetAttachmentRequest) (*GetAttachmentResult, error) + func (c *Client) GetRequestStatus(ctx context.Context, req *GetRequestStatusRequest) (*RequestStatusResult, error) + func (c *Client) GetSavedSearch(ctx context.Context, req *GetSavedSearchRequest) (*GetSavedSearchResult, error) + func (c *Client) List(ctx context.Context, req *ListAlertRequest) (*ListAlertResult, error) + func (c *Client) ListAlertLogs(ctx context.Context, req *ListAlertLogsRequest) (*ListAlertLogsResult, error) + func (c *Client) ListAlertNotes(ctx context.Context, req *ListAlertNotesRequest) (*ListAlertNotesResult, error) + func (c *Client) ListAlertRecipients(ctx context.Context, req *ListAlertRecipientRequest) (*ListAlertRecipientResult, error) + func (c *Client) ListAlertsAttachments(ctx context.Context, req *ListAttachmentsRequest) (*ListAttachmentsResult, error) + func (c *Client) ListSavedSearches(ctx context.Context, req *ListSavedSearchRequest) (*SavedSearchResult, error) + func (c *Client) RemoveDetails(ctx context.Context, req *RemoveDetailsRequest) (*AsyncAlertResult, error) + func (c *Client) RemoveTags(ctx context.Context, req *RemoveTagsRequest) (*AsyncAlertResult, error) + func (c *Client) Snooze(ctx context.Context, req *SnoozeAlertRequest) (*AsyncAlertResult, error) + func (c *Client) Unacknowledge(ctx context.Context, req *UnacknowledgeAlertRequest) (*AsyncAlertResult, error) + func (c *Client) UpdateDescription(ctx context.Context, req *UpdateDescriptionRequest) (*AsyncAlertResult, error) + func (c *Client) UpdateMessage(ctx context.Context, req *UpdateMessageRequest) (*AsyncAlertResult, error) + func (c *Client) UpdatePriority(ctx context.Context, req *UpdatePriorityRequest) (*AsyncAlertResult, error) + func (c *Client) UpdateSavedSearch(ctx context.Context, req *UpdateSavedSearchRequest) (*SavedSearchResult, error) + type CloseAlertRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *CloseAlertRequest) Method() string + func (r *CloseAlertRequest) RequestParams() map[string]string + func (r *CloseAlertRequest) ResourcePath() string + func (r *CloseAlertRequest) Validate() error + type CountAlertResult struct + Count int + type CountAlertsRequest struct + Query string + SearchIdentifier string + SearchIdentifierType SearchIdentifierType + func (r *CountAlertsRequest) Method() string + func (r *CountAlertsRequest) RequestParams() map[string]string + func (r *CountAlertsRequest) ResourcePath() string + func (r *CountAlertsRequest) Validate() error + type CreateAlertAttachmentRequest struct + FileName string + FilePath string + IdentifierType AlertIdentifier + IdentifierValue string + IndexFile string + User string + func (r *CreateAlertAttachmentRequest) Metadata(ar client.ApiRequest) map[string]interface{} + func (r *CreateAlertAttachmentRequest) Method() string + func (r *CreateAlertAttachmentRequest) RequestParams() map[string]string + func (r *CreateAlertAttachmentRequest) ResourcePath() string + func (r *CreateAlertAttachmentRequest) Validate() error + type CreateAlertAttachmentsResult struct + Attachment CreatedAttachment + Result string + type CreateAlertRequest struct + Actions []string + Alias string + Description string + Details map[string]string + Entity string + Message string + Note string + Priority Priority + Responders []Responder + Source string + Tags []string + User string + VisibleTo []Responder + func (r *CreateAlertRequest) Method() string + func (r *CreateAlertRequest) ResourcePath() string + func (r *CreateAlertRequest) Validate() error + type CreateSavedSearchRequest struct + Description string + Name string + Owner User + Query string + Teams []Team + func (r *CreateSavedSearchRequest) Method() string + func (r *CreateSavedSearchRequest) ResourcePath() string + func (r *CreateSavedSearchRequest) Validate() error + type CreatedAttachment struct + Id string + type DeleteAlertAttachmentResult struct + Result string + type DeleteAlertRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Source string + func (r *DeleteAlertRequest) Method() string + func (r *DeleteAlertRequest) RequestParams() map[string]string + func (r *DeleteAlertRequest) ResourcePath() string + func (r *DeleteAlertRequest) Validate() error + type DeleteAttachmentRequest struct + AttachmentId string + IdentifierType AlertIdentifier + IdentifierValue string + User string + func (r *DeleteAttachmentRequest) Method() string + func (r *DeleteAttachmentRequest) RequestParams() map[string]string + func (r *DeleteAttachmentRequest) ResourcePath() string + func (r *DeleteAttachmentRequest) Validate() error + type DeleteSavedSearchRequest struct + IdentifierType SearchIdentifierType + IdentifierValue string + func (r *DeleteSavedSearchRequest) Method() string + func (r *DeleteSavedSearchRequest) RequestParams() map[string]string + func (r *DeleteSavedSearchRequest) ResourcePath() string + func (r *DeleteSavedSearchRequest) Validate() error + type EscalateToNextRequest struct + Escalation Escalation + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *EscalateToNextRequest) Method() string + func (r *EscalateToNextRequest) RequestParams() map[string]string + func (r *EscalateToNextRequest) ResourcePath() string + func (r *EscalateToNextRequest) Validate() error + type Escalation struct + ID string + Name string + type ExecuteCustomActionAlertRequest struct + Action string + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *ExecuteCustomActionAlertRequest) Method() string + func (r *ExecuteCustomActionAlertRequest) RequestParams() map[string]string + func (r *ExecuteCustomActionAlertRequest) ResourcePath() string + func (r *ExecuteCustomActionAlertRequest) Validate() error + type GetAlertRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + func (r *GetAlertRequest) Method() string + func (r *GetAlertRequest) RequestParams() map[string]string + func (r *GetAlertRequest) ResourcePath() string + func (r *GetAlertRequest) Validate() error + type GetAlertResult struct + Acknowledged bool + Actions []string + Alias string + Count int + CreatedAt time.Time + Description string + Details map[string]string + Entity string + Id string + Integration Integration + IsSeen bool + LastOccurredAt time.Time + Message string + Owner string + Priority Priority + Report Report + Responders []Responder + Snoozed bool + SnoozedUntil time.Time + Source string + Status string + Tags []string + TinyId string + UpdatedAt time.Time + type GetAttachmentRequest struct + AttachmentId string + IdentifierType AlertIdentifier + IdentifierValue string + func (r *GetAttachmentRequest) Method() string + func (r *GetAttachmentRequest) RequestParams() map[string]string + func (r *GetAttachmentRequest) ResourcePath() string + func (r *GetAttachmentRequest) Validate() error + type GetAttachmentResult struct + Name string + Url string + type GetRequestStatusRequest struct + RequestId string + func (r *GetRequestStatusRequest) Method() string + func (r *GetRequestStatusRequest) ResourcePath() string + func (r *GetRequestStatusRequest) Validate() error + type GetSavedSearchRequest struct + IdentifierType SearchIdentifierType + IdentifierValue string + func (r *GetSavedSearchRequest) Method() string + func (r *GetSavedSearchRequest) RequestParams() map[string]string + func (r *GetSavedSearchRequest) ResourcePath() string + func (r *GetSavedSearchRequest) Validate() error + type GetSavedSearchResult struct + CreatedAt time.Time + Description string + Id string + Name string + Query string + Teams []Team + UpdatedAt time.Time + type Integration struct + Id string + Name string + Type string + type ListAlertLogsRequest struct + Direction RequestDirection + IdentifierType AlertIdentifier + IdentifierValue string + Limit uint32 + Offset string + Order Order + func (r *ListAlertLogsRequest) Method() string + func (r *ListAlertLogsRequest) RequestParams() map[string]string + func (r *ListAlertLogsRequest) ResourcePath() string + func (r *ListAlertLogsRequest) Validate() error + type ListAlertLogsResult struct + AlertLog []AlertLog + Paging map[string]string + type ListAlertNotesRequest struct + Direction RequestDirection + IdentifierType AlertIdentifier + IdentifierValue string + Limit uint32 + Offset string + Order Order + func (r *ListAlertNotesRequest) Method() string + func (r *ListAlertNotesRequest) RequestParams() map[string]string + func (r *ListAlertNotesRequest) ResourcePath() string + func (r *ListAlertNotesRequest) Validate() error + type ListAlertNotesResult struct + AlertLog []AlertNote + Paging map[string]string + type ListAlertRecipientRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + func (r *ListAlertRecipientRequest) Method() string + func (r *ListAlertRecipientRequest) RequestParams() map[string]string + func (r *ListAlertRecipientRequest) ResourcePath() string + func (r *ListAlertRecipientRequest) Validate() error + type ListAlertRecipientResult struct + AlertRecipients []AlertRecipient + type ListAlertRequest struct + Limit int + Offset int + Order Order + Query string + SearchIdentifier string + SearchIdentifierType SearchIdentifierType + Sort SortField + func (r *ListAlertRequest) Method() string + func (r *ListAlertRequest) RequestParams() map[string]string + func (r *ListAlertRequest) ResourcePath() string + func (r *ListAlertRequest) Validate() error + type ListAlertResult struct + Alerts []Alert + type ListAttachmentsRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + func (r *ListAttachmentsRequest) Method() string + func (r *ListAttachmentsRequest) RequestParams() map[string]string + func (r *ListAttachmentsRequest) ResourcePath() string + func (r *ListAttachmentsRequest) Validate() error + type ListAttachmentsResult struct + Attachment []ListedAttachment + type ListSavedSearchRequest struct + func (r *ListSavedSearchRequest) Method() string + func (r *ListSavedSearchRequest) ResourcePath() string + func (r *ListSavedSearchRequest) Validate() error + type ListedAttachment struct + Id int64 + Name string + type Order string + const Asc + const Desc + type Priority string + const P1 + const P2 + const P3 + const P4 + const P5 + type RemoveDetailsRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Keys string + Note string + Source string + User string + func (r *RemoveDetailsRequest) Method() string + func (r *RemoveDetailsRequest) RequestParams() map[string]string + func (r *RemoveDetailsRequest) ResourcePath() string + func (r *RemoveDetailsRequest) Validate() error + type RemoveTagsRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + Tags string + User string + func (r *RemoveTagsRequest) Method() string + func (r *RemoveTagsRequest) RequestParams() map[string]string + func (r *RemoveTagsRequest) ResourcePath() string + func (r *RemoveTagsRequest) Validate() error + type Report struct + AckTime int64 + AcknowledgedBy string + CloseTime int64 + ClosedBy string + type RequestDirection string + const NEXT + const PREV + type RequestStatusResult struct + Action string + AlertID string + Alias string + IntegrationId string + IsSuccess bool + ProcessedAt time.Time + Status string + type Responder struct + Id string + Name string + Type ResponderType + Username string + type ResponderType string + const EscalationResponder + const ScheduleResponder + const TeamResponder + const UserResponder + type SavedSearchResult struct + Id string + Name string + type Schedule struct + ID string + Name string + func (s *Schedule) SetID(id string) + func (s *Schedule) SetUsername(name string) + type SearchIdentifierType string + const ID + const NAME + type SnoozeAlertRequest struct + EndTime time.Time + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *SnoozeAlertRequest) Method() string + func (r *SnoozeAlertRequest) RequestParams() map[string]string + func (r *SnoozeAlertRequest) ResourcePath() string + func (r *SnoozeAlertRequest) Validate() error + type SortField string + const AckTime + const Acknowledged + const AcknowledgedBy + const Alias + const CloseTime + const ClosedBy + const Count + const CreatedAt + const IntegrationName + const IntegrationType + const IsSeen + const LastOccurredAt + const Message + const Owner + const Snoozed + const SnoozedUntil + const Source + const Status + const TinyId + const UpdatedAt + type Team struct + ID string + Name string + type UnacknowledgeAlertRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Note string + Source string + User string + func (r *UnacknowledgeAlertRequest) Method() string + func (r *UnacknowledgeAlertRequest) RequestParams() map[string]string + func (r *UnacknowledgeAlertRequest) ResourcePath() string + func (r *UnacknowledgeAlertRequest) Validate() error + type UpdateDescriptionRequest struct + Description string + IdentifierType AlertIdentifier + IdentifierValue string + func (r *UpdateDescriptionRequest) Method() string + func (r *UpdateDescriptionRequest) RequestParams() map[string]string + func (r *UpdateDescriptionRequest) ResourcePath() string + func (r *UpdateDescriptionRequest) Validate() error + type UpdateMessageRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Message string + func (r *UpdateMessageRequest) Method() string + func (r *UpdateMessageRequest) RequestParams() map[string]string + func (r *UpdateMessageRequest) ResourcePath() string + func (r *UpdateMessageRequest) Validate() error + type UpdatePriorityRequest struct + IdentifierType AlertIdentifier + IdentifierValue string + Priority Priority + func (r *UpdatePriorityRequest) Method() string + func (r *UpdatePriorityRequest) RequestParams() map[string]string + func (r *UpdatePriorityRequest) ResourcePath() string + func (r *UpdatePriorityRequest) Validate() error + type UpdateSavedSearchRequest struct + Description string + IdentifierType SearchIdentifierType + IdentifierValue string + NewName string + Owner User + Query string + Teams []Team + func (r *UpdateSavedSearchRequest) Method() string + func (r *UpdateSavedSearchRequest) RequestParams() map[string]string + func (r *UpdateSavedSearchRequest) ResourcePath() string + func (r *UpdateSavedSearchRequest) Validate() error + type User struct + ID string + Username string