Documentation
¶
Index ¶
- Constants
- type Alert
- type AlertGroup
- type AlertGroups
- type AlertStatus
- type AlertmanagerConfig
- type AlertmanagerStatus
- type ClusterStatus
- type GettableAlert
- type GettableAlerts
- type GettableSilence
- type GettableSilences
- type LabelSet
- type Matcher
- type Matchers
- type PeerStatus
- type PostableAlert
- type PostableAlerts
- type PostableSilence
- type Receiver
- type Silence
- type SilenceStatus
- type VersionInfo
Constants ¶
const ( // AlertStatusStateUnprocessed captures enum value "unprocessed" AlertStatusStateUnprocessed string = "unprocessed" // AlertStatusStateActive captures enum value "active" AlertStatusStateActive string = "active" // AlertStatusStateSuppressed captures enum value "suppressed" AlertStatusStateSuppressed string = "suppressed" )
const ( // ClusterStatusStatusReady captures enum value "ready" ClusterStatusStatusReady string = "ready" // ClusterStatusStatusSettling captures enum value "settling" ClusterStatusStatusSettling string = "settling" // ClusterStatusStatusDisabled captures enum value "disabled" ClusterStatusStatusDisabled string = "disabled" )
const ( // SilenceStatusStateExpired captures enum value "expired" SilenceStatusStateExpired string = "expired" // SilenceStatusStateActive captures enum value "active" SilenceStatusStateActive string = "active" // SilenceStatusStatePending captures enum value "pending" SilenceStatusStatePending string = "pending" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Alert ¶
type Alert struct {
// generator URL
// Format: uri
GeneratorURL strfmt.URI `json:"generatorURL,omitempty"`
// labels
// Required: true
Labels LabelSet `json:"labels"`
}
Alert alert
swagger:model alert
func (*Alert) MarshalBinary ¶
MarshalBinary interface implementation
func (*Alert) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AlertGroup ¶ added in v0.17.0
type AlertGroup struct {
// alerts
// Required: true
Alerts []*GettableAlert `json:"alerts"`
// labels
// Required: true
Labels LabelSet `json:"labels"`
// receiver
// Required: true
Receiver *Receiver `json:"receiver"`
}
AlertGroup alert group
swagger:model alertGroup
func (*AlertGroup) MarshalBinary ¶ added in v0.17.0
func (m *AlertGroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlertGroup) UnmarshalBinary ¶ added in v0.17.0
func (m *AlertGroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AlertGroups ¶ added in v0.17.0
type AlertGroups []*AlertGroup
AlertGroups alert groups
swagger:model alertGroups
type AlertStatus ¶
type AlertStatus struct {
// inhibited by
// Required: true
InhibitedBy []string `json:"inhibitedBy"`
// silenced by
// Required: true
SilencedBy []string `json:"silencedBy"`
// state
// Required: true
// Enum: [unprocessed active suppressed]
State *string `json:"state"`
}
AlertStatus alert status
swagger:model alertStatus
func (*AlertStatus) MarshalBinary ¶
func (m *AlertStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlertStatus) UnmarshalBinary ¶
func (m *AlertStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AlertmanagerConfig ¶
type AlertmanagerConfig struct {
// original
// Required: true
Original *string `json:"original"`
}
AlertmanagerConfig alertmanager config
swagger:model alertmanagerConfig
func (*AlertmanagerConfig) MarshalBinary ¶
func (m *AlertmanagerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlertmanagerConfig) UnmarshalBinary ¶
func (m *AlertmanagerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AlertmanagerStatus ¶
type AlertmanagerStatus struct {
// cluster
// Required: true
Cluster *ClusterStatus `json:"cluster"`
// config
// Required: true
Config *AlertmanagerConfig `json:"config"`
// uptime
// Required: true
// Format: date-time
Uptime *strfmt.DateTime `json:"uptime"`
// version info
// Required: true
VersionInfo *VersionInfo `json:"versionInfo"`
}
AlertmanagerStatus alertmanager status
swagger:model alertmanagerStatus
func (*AlertmanagerStatus) MarshalBinary ¶
func (m *AlertmanagerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlertmanagerStatus) UnmarshalBinary ¶
func (m *AlertmanagerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ClusterStatus ¶
type ClusterStatus struct {
// name
Name string `json:"name,omitempty"`
// peers
Peers []*PeerStatus `json:"peers"`
// status
// Required: true
// Enum: [ready settling disabled]
Status *string `json:"status"`
}
ClusterStatus cluster status
swagger:model clusterStatus
func (*ClusterStatus) MarshalBinary ¶
func (m *ClusterStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ClusterStatus) UnmarshalBinary ¶
func (m *ClusterStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GettableAlert ¶
type GettableAlert struct {
// annotations
// Required: true
Annotations LabelSet `json:"annotations"`
// ends at
// Required: true
// Format: date-time
EndsAt *strfmt.DateTime `json:"endsAt"`
// fingerprint
// Required: true
Fingerprint *string `json:"fingerprint"`
// receivers
// Required: true
Receivers []*Receiver `json:"receivers"`
// starts at
// Required: true
// Format: date-time
StartsAt *strfmt.DateTime `json:"startsAt"`
// status
// Required: true
Status *AlertStatus `json:"status"`
// updated at
// Required: true
// Format: date-time
UpdatedAt *strfmt.DateTime `json:"updatedAt"`
Alert
}
GettableAlert gettable alert
swagger:model gettableAlert
func (*GettableAlert) MarshalBinary ¶
func (m *GettableAlert) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (GettableAlert) MarshalJSON ¶
func (m GettableAlert) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*GettableAlert) UnmarshalBinary ¶
func (m *GettableAlert) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*GettableAlert) UnmarshalJSON ¶
func (m *GettableAlert) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type GettableAlerts ¶
type GettableAlerts []*GettableAlert
GettableAlerts gettable alerts
swagger:model gettableAlerts
type GettableSilence ¶
type GettableSilence struct {
// id
// Required: true
ID *string `json:"id"`
// status
// Required: true
Status *SilenceStatus `json:"status"`
// updated at
// Required: true
// Format: date-time
UpdatedAt *strfmt.DateTime `json:"updatedAt"`
Silence
}
GettableSilence gettable silence
swagger:model gettableSilence
func (*GettableSilence) MarshalBinary ¶
func (m *GettableSilence) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (GettableSilence) MarshalJSON ¶
func (m GettableSilence) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*GettableSilence) UnmarshalBinary ¶
func (m *GettableSilence) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*GettableSilence) UnmarshalJSON ¶
func (m *GettableSilence) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type GettableSilences ¶
type GettableSilences []*GettableSilence
GettableSilences gettable silences
swagger:model gettableSilences
type Matcher ¶
type Matcher struct {
// is equal
IsEqual *bool `json:"isEqual,omitempty"`
// is regex
// Required: true
IsRegex *bool `json:"isRegex"`
// name
// Required: true
Name *string `json:"name"`
// value
// Required: true
Value *string `json:"value"`
}
Matcher matcher
swagger:model matcher
func (*Matcher) MarshalBinary ¶
MarshalBinary interface implementation
func (*Matcher) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PeerStatus ¶
type PeerStatus struct {
// address
// Required: true
Address *string `json:"address"`
// name
// Required: true
Name *string `json:"name"`
}
PeerStatus peer status
swagger:model peerStatus
func (*PeerStatus) MarshalBinary ¶
func (m *PeerStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PeerStatus) UnmarshalBinary ¶
func (m *PeerStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PostableAlert ¶
type PostableAlert struct {
// annotations
Annotations LabelSet `json:"annotations,omitempty"`
// ends at
// Format: date-time
EndsAt strfmt.DateTime `json:"endsAt,omitempty"`
// starts at
// Format: date-time
StartsAt strfmt.DateTime `json:"startsAt,omitempty"`
Alert
}
PostableAlert postable alert
swagger:model postableAlert
func (*PostableAlert) MarshalBinary ¶
func (m *PostableAlert) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PostableAlert) MarshalJSON ¶
func (m PostableAlert) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PostableAlert) UnmarshalBinary ¶
func (m *PostableAlert) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PostableAlert) UnmarshalJSON ¶
func (m *PostableAlert) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type PostableAlerts ¶
type PostableAlerts []*PostableAlert
PostableAlerts postable alerts
swagger:model postableAlerts
type PostableSilence ¶
PostableSilence postable silence
swagger:model postableSilence
func (*PostableSilence) MarshalBinary ¶
func (m *PostableSilence) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PostableSilence) MarshalJSON ¶
func (m PostableSilence) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PostableSilence) UnmarshalBinary ¶
func (m *PostableSilence) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PostableSilence) UnmarshalJSON ¶
func (m *PostableSilence) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Receiver ¶
type Receiver struct {
// name
// Required: true
Name *string `json:"name"`
}
Receiver receiver
swagger:model receiver
func (*Receiver) MarshalBinary ¶
MarshalBinary interface implementation
func (*Receiver) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Silence ¶
type Silence struct {
// comment
// Required: true
Comment *string `json:"comment"`
// created by
// Required: true
CreatedBy *string `json:"createdBy"`
// ends at
// Required: true
// Format: date-time
EndsAt *strfmt.DateTime `json:"endsAt"`
// matchers
// Required: true
Matchers Matchers `json:"matchers"`
// starts at
// Required: true
// Format: date-time
StartsAt *strfmt.DateTime `json:"startsAt"`
}
Silence silence
swagger:model silence
func (*Silence) MarshalBinary ¶
MarshalBinary interface implementation
func (*Silence) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SilenceStatus ¶
type SilenceStatus struct {
// state
// Required: true
// Enum: [expired active pending]
State *string `json:"state"`
}
SilenceStatus silence status
swagger:model silenceStatus
func (*SilenceStatus) MarshalBinary ¶
func (m *SilenceStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SilenceStatus) UnmarshalBinary ¶
func (m *SilenceStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionInfo ¶
type VersionInfo struct {
// branch
// Required: true
Branch *string `json:"branch"`
// build date
// Required: true
BuildDate *string `json:"buildDate"`
// build user
// Required: true
BuildUser *string `json:"buildUser"`
// go version
// Required: true
GoVersion *string `json:"goVersion"`
// revision
// Required: true
Revision *string `json:"revision"`
// version
// Required: true
Version *string `json:"version"`
}
VersionInfo version info
swagger:model versionInfo
func (*VersionInfo) MarshalBinary ¶
func (m *VersionInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionInfo) UnmarshalBinary ¶
func (m *VersionInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- alert.go
- alert_group.go
- alert_groups.go
- alert_status.go
- alertmanager_config.go
- alertmanager_status.go
- cluster_status.go
- gettable_alert.go
- gettable_alerts.go
- gettable_silence.go
- gettable_silences.go
- label_set.go
- matcher.go
- matchers.go
- peer_status.go
- postable_alert.go
- postable_alerts.go
- postable_silence.go
- receiver.go
- silence.go
- silence_status.go
- version_info.go