Documentation
¶
Index ¶
- type APIError
- type CommonLabel
- type Datav1Severity
- type MonitorStatusSignalStatus
- func (m *MonitorStatusSignalStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *MonitorStatusSignalStatus) MarshalBinary() ([]byte, error)
- func (m *MonitorStatusSignalStatus) UnmarshalBinary(b []byte) error
- func (m *MonitorStatusSignalStatus) Validate(formats strfmt.Registry) error
- type SignalStatusSeriesStatus
- func (m *SignalStatusSeriesStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SignalStatusSeriesStatus) MarshalBinary() ([]byte, error)
- func (m *SignalStatusSeriesStatus) UnmarshalBinary(b []byte) error
- func (m *SignalStatusSeriesStatus) Validate(formats strfmt.Registry) error
- type StateUnstableListTestNotificationRecipientsBody
- func (m *StateUnstableListTestNotificationRecipientsBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateUnstableListTestNotificationRecipientsBody) MarshalBinary() ([]byte, error)
- func (m *StateUnstableListTestNotificationRecipientsBody) UnmarshalBinary(b []byte) error
- func (m *StateUnstableListTestNotificationRecipientsBody) Validate(formats strfmt.Registry) error
- type StateUnstableSendTestNotificationBody
- func (m *StateUnstableSendTestNotificationBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateUnstableSendTestNotificationBody) MarshalBinary() ([]byte, error)
- func (m *StateUnstableSendTestNotificationBody) UnmarshalBinary(b []byte) error
- func (m *StateUnstableSendTestNotificationBody) Validate(formats strfmt.Registry) error
- type StateunstableAlertingState
- type StateunstableEchoResponse
- func (m *StateunstableEchoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateunstableEchoResponse) MarshalBinary() ([]byte, error)
- func (m *StateunstableEchoResponse) UnmarshalBinary(b []byte) error
- func (m *StateunstableEchoResponse) Validate(formats strfmt.Registry) error
- type StateunstableListMonitorStatusesResponse
- func (m *StateunstableListMonitorStatusesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateunstableListMonitorStatusesResponse) MarshalBinary() ([]byte, error)
- func (m *StateunstableListMonitorStatusesResponse) UnmarshalBinary(b []byte) error
- func (m *StateunstableListMonitorStatusesResponse) Validate(formats strfmt.Registry) error
- type StateunstableListTestNotificationRecipientsResponse
- func (m *StateunstableListTestNotificationRecipientsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateunstableListTestNotificationRecipientsResponse) MarshalBinary() ([]byte, error)
- func (m *StateunstableListTestNotificationRecipientsResponse) UnmarshalBinary(b []byte) error
- func (m *StateunstableListTestNotificationRecipientsResponse) Validate(formats strfmt.Registry) error
- type StateunstableMonitorStatus
- func (m *StateunstableMonitorStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateunstableMonitorStatus) MarshalBinary() ([]byte, error)
- func (m *StateunstableMonitorStatus) UnmarshalBinary(b []byte) error
- func (m *StateunstableMonitorStatus) Validate(formats strfmt.Registry) error
- type StateunstableSendTestNotificationResponse
- type StateunstableTestNotificationRecipient
- func (m *StateunstableTestNotificationRecipient) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *StateunstableTestNotificationRecipient) MarshalBinary() ([]byte, error)
- func (m *StateunstableTestNotificationRecipient) UnmarshalBinary(b []byte) error
- func (m *StateunstableTestNotificationRecipient) Validate(formats strfmt.Registry) error
- type TestNotificationRecipientRecipientType
- func (m TestNotificationRecipientRecipientType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m TestNotificationRecipientRecipientType) Pointer() *TestNotificationRecipientRecipientType
- func (m TestNotificationRecipientRecipientType) Validate(formats strfmt.Registry) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIError ¶
type APIError struct {
// An optional private error code whose values are undefined.
Code int32 `json:"code,omitempty"`
// An error message describing what went wrong.
Message string `json:"message,omitempty"`
}
APIError api error
swagger:model apiError
func (*APIError) ContextValidate ¶
ContextValidate validates this api error based on context it is used
func (*APIError) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIError) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CommonLabel ¶ added in v1.14.0
type CommonLabel struct {
// name
Name string `json:"name,omitempty"`
// value
Value string `json:"value,omitempty"`
}
CommonLabel common label
swagger:model commonLabel
func (*CommonLabel) ContextValidate ¶ added in v1.14.0
ContextValidate validates this common label based on context it is used
func (*CommonLabel) MarshalBinary ¶ added in v1.14.0
func (m *CommonLabel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommonLabel) UnmarshalBinary ¶ added in v1.14.0
func (m *CommonLabel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Datav1Severity ¶ added in v1.37.0
type Datav1Severity string
Datav1Severity The severity an alert fired at.
swagger:model datav1Severity
const ( // Datav1SeverityWARN captures enum value "WARN" Datav1SeverityWARN Datav1Severity = "WARN" // Datav1SeverityCRITICAL captures enum value "CRITICAL" Datav1SeverityCRITICAL Datav1Severity = "CRITICAL" )
func NewDatav1Severity ¶ added in v1.37.0
func NewDatav1Severity(value Datav1Severity) *Datav1Severity
func (Datav1Severity) ContextValidate ¶ added in v1.37.0
ContextValidate validates this datav1 severity based on context it is used
func (Datav1Severity) Pointer ¶ added in v1.37.0
func (m Datav1Severity) Pointer() *Datav1Severity
Pointer returns a pointer to a freshly-allocated Datav1Severity.
type MonitorStatusSignalStatus ¶ added in v1.14.0
type MonitorStatusSignalStatus struct {
// state
State StateunstableAlertingState `json:"state,omitempty"`
// severity
Severity string `json:"severity,omitempty"`
// Signal labels.
SignalLabels []*CommonLabel `json:"signal_labels"`
// This field is deprecated.
Series []*SignalStatusSeriesStatus `json:"series"`
// When the signal started firing: the earliest among its firing severities.
// Format: date-time
StartedAt strfmt.DateTime `json:"started_at,omitempty"`
}
MonitorStatusSignalStatus monitor status signal status
swagger:model MonitorStatusSignalStatus
func (*MonitorStatusSignalStatus) ContextValidate ¶ added in v1.14.0
func (m *MonitorStatusSignalStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this monitor status signal status based on the context it is used
func (*MonitorStatusSignalStatus) MarshalBinary ¶ added in v1.14.0
func (m *MonitorStatusSignalStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MonitorStatusSignalStatus) UnmarshalBinary ¶ added in v1.14.0
func (m *MonitorStatusSignalStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SignalStatusSeriesStatus ¶ added in v1.14.0
type SignalStatusSeriesStatus struct {
// state
State StateunstableAlertingState `json:"state,omitempty"`
// severity
Severity string `json:"severity,omitempty"`
// Series labels.
Labels []*CommonLabel `json:"labels"`
// started at
// Format: date-time
StartedAt strfmt.DateTime `json:"started_at,omitempty"`
}
SignalStatusSeriesStatus This message is deprecated.
swagger:model SignalStatusSeriesStatus
func (*SignalStatusSeriesStatus) ContextValidate ¶ added in v1.14.0
func (m *SignalStatusSeriesStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this signal status series status based on the context it is used
func (*SignalStatusSeriesStatus) MarshalBinary ¶ added in v1.14.0
func (m *SignalStatusSeriesStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SignalStatusSeriesStatus) UnmarshalBinary ¶ added in v1.14.0
func (m *SignalStatusSeriesStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateUnstableListTestNotificationRecipientsBody ¶ added in v1.37.0
type StateUnstableListTestNotificationRecipientsBody struct {
// severity
Severity Datav1Severity `json:"severity,omitempty"`
// Labels of the signal the test notification is for. When the monitor
// groups signals by label names, only those names are accepted; when it
// uses one signal per series, any name is accepted; when it has no signal
// grouping, none are accepted. Names starting with `__chrono_`,
// `alertname`, and `severity`, are reserved.
// Example: {\"env\": \"prod\"}
SignalLabels map[string]string `json:"signal_labels,omitempty"`
// Render each recipient's notification preview. Previews cost a render per
// integration, so leave this false when only recipient IDs are needed.
IncludePreviews bool `json:"include_previews,omitempty"`
}
StateUnstableListTestNotificationRecipientsBody state unstable list test notification recipients body
swagger:model StateUnstableListTestNotificationRecipientsBody
func (*StateUnstableListTestNotificationRecipientsBody) ContextValidate ¶ added in v1.37.0
func (m *StateUnstableListTestNotificationRecipientsBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this state unstable list test notification recipients body based on the context it is used
func (*StateUnstableListTestNotificationRecipientsBody) MarshalBinary ¶ added in v1.37.0
func (m *StateUnstableListTestNotificationRecipientsBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateUnstableListTestNotificationRecipientsBody) UnmarshalBinary ¶ added in v1.37.0
func (m *StateUnstableListTestNotificationRecipientsBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateUnstableSendTestNotificationBody ¶ added in v1.37.0
type StateUnstableSendTestNotificationBody struct {
// severity
Severity Datav1Severity `json:"severity,omitempty"`
// Labels of the signal the test notification is for. Same rules as
// ListTestNotificationRecipients's `signal_labels`.
// Example: {\"env\": \"prod\"}
SignalLabels map[string]string `json:"signal_labels,omitempty"`
// IDs from ListTestNotificationRecipients to deliver to. When empty,
// delivers to every recipient the test alert routes to with these signal
// labels. An unknown or stale ID fails the request.
RecipientIds []string `json:"recipient_ids"`
}
StateUnstableSendTestNotificationBody state unstable send test notification body
swagger:model StateUnstableSendTestNotificationBody
func (*StateUnstableSendTestNotificationBody) ContextValidate ¶ added in v1.37.0
func (m *StateUnstableSendTestNotificationBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this state unstable send test notification body based on the context it is used
func (*StateUnstableSendTestNotificationBody) MarshalBinary ¶ added in v1.37.0
func (m *StateUnstableSendTestNotificationBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateUnstableSendTestNotificationBody) UnmarshalBinary ¶ added in v1.37.0
func (m *StateUnstableSendTestNotificationBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateunstableAlertingState ¶ added in v1.14.0
type StateunstableAlertingState string
StateunstableAlertingState - ALERTING_STATE_PASS: Monitor is not triggered.
- ALERTING_STATE_PENDING: Monitor is triggered but not yet alerting.
- ALERTING_STATE_ALERTING: Monitor is triggered and alerting.
- ALERTING_STATE_MUTED: Monitor is triggered but is muted.
swagger:model stateunstableAlertingState
const ( // StateunstableAlertingStateALERTINGSTATEPASS captures enum value "ALERTING_STATE_PASS" StateunstableAlertingStateALERTINGSTATEPASS StateunstableAlertingState = "ALERTING_STATE_PASS" // StateunstableAlertingStateALERTINGSTATEPENDING captures enum value "ALERTING_STATE_PENDING" StateunstableAlertingStateALERTINGSTATEPENDING StateunstableAlertingState = "ALERTING_STATE_PENDING" // StateunstableAlertingStateALERTINGSTATEALERTING captures enum value "ALERTING_STATE_ALERTING" StateunstableAlertingStateALERTINGSTATEALERTING StateunstableAlertingState = "ALERTING_STATE_ALERTING" // StateunstableAlertingStateALERTINGSTATEMUTED captures enum value "ALERTING_STATE_MUTED" StateunstableAlertingStateALERTINGSTATEMUTED StateunstableAlertingState = "ALERTING_STATE_MUTED" )
func NewStateunstableAlertingState ¶ added in v1.14.0
func NewStateunstableAlertingState(value StateunstableAlertingState) *StateunstableAlertingState
func (StateunstableAlertingState) ContextValidate ¶ added in v1.14.0
func (m StateunstableAlertingState) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this stateunstable alerting state based on context it is used
func (StateunstableAlertingState) Pointer ¶ added in v1.14.0
func (m StateunstableAlertingState) Pointer() *StateunstableAlertingState
Pointer returns a pointer to a freshly-allocated StateunstableAlertingState.
type StateunstableEchoResponse ¶
type StateunstableEchoResponse struct {
// message
Message string `json:"message,omitempty"`
}
StateunstableEchoResponse stateunstable echo response
swagger:model stateunstableEchoResponse
func (*StateunstableEchoResponse) ContextValidate ¶
func (m *StateunstableEchoResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this stateunstable echo response based on context it is used
func (*StateunstableEchoResponse) MarshalBinary ¶
func (m *StateunstableEchoResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateunstableEchoResponse) UnmarshalBinary ¶
func (m *StateunstableEchoResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateunstableListMonitorStatusesResponse ¶ added in v1.14.0
type StateunstableListMonitorStatusesResponse struct {
// monitor statuses
MonitorStatuses []*StateunstableMonitorStatus `json:"monitor_statuses"`
}
StateunstableListMonitorStatusesResponse stateunstable list monitor statuses response
swagger:model stateunstableListMonitorStatusesResponse
func (*StateunstableListMonitorStatusesResponse) ContextValidate ¶ added in v1.14.0
func (m *StateunstableListMonitorStatusesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this stateunstable list monitor statuses response based on the context it is used
func (*StateunstableListMonitorStatusesResponse) MarshalBinary ¶ added in v1.14.0
func (m *StateunstableListMonitorStatusesResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateunstableListMonitorStatusesResponse) UnmarshalBinary ¶ added in v1.14.0
func (m *StateunstableListMonitorStatusesResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateunstableListTestNotificationRecipientsResponse ¶ added in v1.37.0
type StateunstableListTestNotificationRecipientsResponse struct {
// Every recipient reachable from the monitor's notification policy at the
// severity, using the policy's default routes and then every override route,
// each listed once. Override label matchers are not applied. Empty when the
// monitor has no notification policy.
Recipients []*StateunstableTestNotificationRecipient `json:"recipients"`
}
StateunstableListTestNotificationRecipientsResponse stateunstable list test notification recipients response
swagger:model stateunstableListTestNotificationRecipientsResponse
func (*StateunstableListTestNotificationRecipientsResponse) ContextValidate ¶ added in v1.37.0
func (m *StateunstableListTestNotificationRecipientsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this stateunstable list test notification recipients response based on the context it is used
func (*StateunstableListTestNotificationRecipientsResponse) MarshalBinary ¶ added in v1.37.0
func (m *StateunstableListTestNotificationRecipientsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateunstableListTestNotificationRecipientsResponse) UnmarshalBinary ¶ added in v1.37.0
func (m *StateunstableListTestNotificationRecipientsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateunstableMonitorStatus ¶ added in v1.14.0
type StateunstableMonitorStatus struct {
// slug
Slug string `json:"slug,omitempty"`
// state
State StateunstableAlertingState `json:"state,omitempty"`
// severity
Severity string `json:"severity,omitempty"`
// signals
Signals []*MonitorStatusSignalStatus `json:"signals"`
}
StateunstableMonitorStatus MonitorStatus contains the status of a monitor.
swagger:model stateunstableMonitorStatus
func (*StateunstableMonitorStatus) ContextValidate ¶ added in v1.14.0
func (m *StateunstableMonitorStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this stateunstable monitor status based on the context it is used
func (*StateunstableMonitorStatus) MarshalBinary ¶ added in v1.14.0
func (m *StateunstableMonitorStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateunstableMonitorStatus) UnmarshalBinary ¶ added in v1.14.0
func (m *StateunstableMonitorStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StateunstableSendTestNotificationResponse ¶ added in v1.37.0
type StateunstableSendTestNotificationResponse interface{}
StateunstableSendTestNotificationResponse Returned when the test notification is accepted for delivery. Acceptance does not confirm that any integration delivered it.
swagger:model stateunstableSendTestNotificationResponse
type StateunstableTestNotificationRecipient ¶ added in v1.37.0
type StateunstableTestNotificationRecipient struct {
// Opaque, server-issued ID. Pass it back in SendTestNotification's
// `recipient_ids`. Stays valid until the notification policy or the
// recipient's notifier changes.
ID string `json:"id,omitempty"`
// The notifier's name, or a generated name describing the destination.
DisplayName string `json:"display_name,omitempty"`
// type
Type TestNotificationRecipientRecipientType `json:"type,omitempty"`
// Markdown preview of the notification this recipient would receive. Set
// only with `include_previews`, and only for recipients the test alert is
// routed to with these signal labels. Templates render against the signal
// labels alone, and values that would come from the monitor's query are
// placeholders. Empty when the preview fails to render.
PreviewMarkdown string `json:"preview_markdown,omitempty"`
}
StateunstableTestNotificationRecipient A recipient of a monitor's notification policy: a notifier, or a destination configured directly on the policy. A destination that sends to several Slack channels or VictorOps routing keys is one recipient per channel or routing key.
swagger:model stateunstableTestNotificationRecipient
func (*StateunstableTestNotificationRecipient) ContextValidate ¶ added in v1.37.0
func (m *StateunstableTestNotificationRecipient) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this stateunstable test notification recipient based on the context it is used
func (*StateunstableTestNotificationRecipient) MarshalBinary ¶ added in v1.37.0
func (m *StateunstableTestNotificationRecipient) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateunstableTestNotificationRecipient) UnmarshalBinary ¶ added in v1.37.0
func (m *StateunstableTestNotificationRecipient) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TestNotificationRecipientRecipientType ¶ added in v1.37.0
type TestNotificationRecipientRecipientType string
TestNotificationRecipientRecipientType - OTHER: A recipient whose integration is not one of the above.
swagger:model TestNotificationRecipientRecipientType
const ( // TestNotificationRecipientRecipientTypeEMAIL captures enum value "EMAIL" TestNotificationRecipientRecipientTypeEMAIL TestNotificationRecipientRecipientType = "EMAIL" // TestNotificationRecipientRecipientTypeSLACK captures enum value "SLACK" TestNotificationRecipientRecipientTypeSLACK TestNotificationRecipientRecipientType = "SLACK" // TestNotificationRecipientRecipientTypePAGERDUTY captures enum value "PAGERDUTY" TestNotificationRecipientRecipientTypePAGERDUTY TestNotificationRecipientRecipientType = "PAGERDUTY" // TestNotificationRecipientRecipientTypeWEBHOOK captures enum value "WEBHOOK" TestNotificationRecipientRecipientTypeWEBHOOK TestNotificationRecipientRecipientType = "WEBHOOK" // TestNotificationRecipientRecipientTypeOPSGENIE captures enum value "OPSGENIE" TestNotificationRecipientRecipientTypeOPSGENIE TestNotificationRecipientRecipientType = "OPSGENIE" // TestNotificationRecipientRecipientTypeVICTOROPS captures enum value "VICTOROPS" TestNotificationRecipientRecipientTypeVICTOROPS TestNotificationRecipientRecipientType = "VICTOROPS" // TestNotificationRecipientRecipientTypeOTHER captures enum value "OTHER" TestNotificationRecipientRecipientTypeOTHER TestNotificationRecipientRecipientType = "OTHER" )
func NewTestNotificationRecipientRecipientType ¶ added in v1.37.0
func NewTestNotificationRecipientRecipientType(value TestNotificationRecipientRecipientType) *TestNotificationRecipientRecipientType
func (TestNotificationRecipientRecipientType) ContextValidate ¶ added in v1.37.0
func (m TestNotificationRecipientRecipientType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this test notification recipient recipient type based on context it is used
func (TestNotificationRecipientRecipientType) Pointer ¶ added in v1.37.0
func (m TestNotificationRecipientRecipientType) Pointer() *TestNotificationRecipientRecipientType
Pointer returns a pointer to a freshly-allocated TestNotificationRecipientRecipientType.
Source Files
¶
- api_error.go
- common_label.go
- datav1_severity.go
- monitor_status_signal_status.go
- signal_status_series_status.go
- state_unstable_list_test_notification_recipients_body.go
- state_unstable_send_test_notification_body.go
- stateunstable_alerting_state.go
- stateunstable_echo_response.go
- stateunstable_list_monitor_statuses_response.go
- stateunstable_list_test_notification_recipients_response.go
- stateunstable_monitor_status.go
- stateunstable_send_test_notification_response.go
- stateunstable_test_notification_recipient.go
- test_notification_recipient_recipient_type.go