Documentation
¶
Index ¶
- type APIError
- type CommonPromQLMatcher
- type CommonPromQLMatcherType
- type Configv1PageResult
- type Datav1LabelFilter
- type Datav1Severity
- type LabelFilterLabelMatcher
- func (m *LabelFilterLabelMatcher) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LabelFilterLabelMatcher) MarshalBinary() ([]byte, error)
- func (m *LabelFilterLabelMatcher) UnmarshalBinary(b []byte) error
- func (m *LabelFilterLabelMatcher) Validate(formats strfmt.Registry) error
- type LabelFilterMatchStrategy
- type LabelMatcherFilterTarget
- type MetricUsageQueryExecutionCountsByType
- func (m *MetricUsageQueryExecutionCountsByType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *MetricUsageQueryExecutionCountsByType) MarshalBinary() ([]byte, error)
- func (m *MetricUsageQueryExecutionCountsByType) UnmarshalBinary(b []byte) error
- func (m *MetricUsageQueryExecutionCountsByType) Validate(formats strfmt.Registry) error
- type MetricUsageReferenceCountsByType
- func (m *MetricUsageReferenceCountsByType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *MetricUsageReferenceCountsByType) MarshalBinary() ([]byte, error)
- func (m *MetricUsageReferenceCountsByType) UnmarshalBinary(b []byte) error
- func (m *MetricUsageReferenceCountsByType) Validate(formats strfmt.Registry) error
- type RuleEvaluationRuleType
- type Statev1ListMetricUsagesByLabelNameResponse
- func (m *Statev1ListMetricUsagesByLabelNameResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1ListMetricUsagesByLabelNameResponse) MarshalBinary() ([]byte, error)
- func (m *Statev1ListMetricUsagesByLabelNameResponse) UnmarshalBinary(b []byte) error
- func (m *Statev1ListMetricUsagesByLabelNameResponse) Validate(formats strfmt.Registry) error
- type Statev1ListMetricUsagesByMetricNameResponse
- func (m *Statev1ListMetricUsagesByMetricNameResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1ListMetricUsagesByMetricNameResponse) MarshalBinary() ([]byte, error)
- func (m *Statev1ListMetricUsagesByMetricNameResponse) UnmarshalBinary(b []byte) error
- func (m *Statev1ListMetricUsagesByMetricNameResponse) Validate(formats strfmt.Registry) error
- type Statev1ListMonitorStatusesRequest
- func (m *Statev1ListMonitorStatusesRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1ListMonitorStatusesRequest) MarshalBinary() ([]byte, error)
- func (m *Statev1ListMonitorStatusesRequest) UnmarshalBinary(b []byte) error
- func (m *Statev1ListMonitorStatusesRequest) Validate(formats strfmt.Registry) error
- type Statev1ListMonitorStatusesResponse
- func (m *Statev1ListMonitorStatusesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1ListMonitorStatusesResponse) MarshalBinary() ([]byte, error)
- func (m *Statev1ListMonitorStatusesResponse) UnmarshalBinary(b []byte) error
- func (m *Statev1ListMonitorStatusesResponse) Validate(formats strfmt.Registry) error
- type Statev1ListRuleEvaluationsResponse
- func (m *Statev1ListRuleEvaluationsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1ListRuleEvaluationsResponse) MarshalBinary() ([]byte, error)
- func (m *Statev1ListRuleEvaluationsResponse) UnmarshalBinary(b []byte) error
- func (m *Statev1ListRuleEvaluationsResponse) Validate(formats strfmt.Registry) error
- type Statev1MetricUsage
- type Statev1MetricUsageByLabelName
- func (m *Statev1MetricUsageByLabelName) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1MetricUsageByLabelName) MarshalBinary() ([]byte, error)
- func (m *Statev1MetricUsageByLabelName) UnmarshalBinary(b []byte) error
- func (m *Statev1MetricUsageByLabelName) Validate(formats strfmt.Registry) error
- type Statev1MetricUsageByMetricName
- func (m *Statev1MetricUsageByMetricName) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Statev1MetricUsageByMetricName) MarshalBinary() ([]byte, error)
- func (m *Statev1MetricUsageByMetricName) UnmarshalBinary(b []byte) error
- func (m *Statev1MetricUsageByMetricName) Validate(formats strfmt.Registry) error
- type Statev1MonitorStatus
- type Statev1RuleEvaluation
- type Statev1RuleEvaluationSeverity
- type Statev1SeverityStatus
- type Statev1SignalStatus
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 CommonPromQLMatcher ¶ added in v1.37.0
type CommonPromQLMatcher struct {
// type
Type CommonPromQLMatcherType `json:"type,omitempty"`
// Prometheus label name for the matcher
Name string `json:"name,omitempty"`
// Prometheus label value for the matcher
Value string `json:"value,omitempty"`
}
CommonPromQLMatcher common prom q l matcher
swagger:model commonPromQLMatcher
func (*CommonPromQLMatcher) ContextValidate ¶ added in v1.37.0
ContextValidate validate this common prom q l matcher based on the context it is used
func (*CommonPromQLMatcher) MarshalBinary ¶ added in v1.37.0
func (m *CommonPromQLMatcher) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CommonPromQLMatcher) UnmarshalBinary ¶ added in v1.37.0
func (m *CommonPromQLMatcher) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CommonPromQLMatcherType ¶ added in v1.37.0
type CommonPromQLMatcherType string
CommonPromQLMatcherType common prom q l matcher type
swagger:model commonPromQLMatcherType
const ( // CommonPromQLMatcherTypeMatchEqual captures enum value "MatchEqual" CommonPromQLMatcherTypeMatchEqual CommonPromQLMatcherType = "MatchEqual" // CommonPromQLMatcherTypeMatchRegexp captures enum value "MatchRegexp" CommonPromQLMatcherTypeMatchRegexp CommonPromQLMatcherType = "MatchRegexp" // CommonPromQLMatcherTypeMatchNotEqual captures enum value "MatchNotEqual" CommonPromQLMatcherTypeMatchNotEqual CommonPromQLMatcherType = "MatchNotEqual" // CommonPromQLMatcherTypeMatchNotRegexp captures enum value "MatchNotRegexp" CommonPromQLMatcherTypeMatchNotRegexp CommonPromQLMatcherType = "MatchNotRegexp" )
func NewCommonPromQLMatcherType ¶ added in v1.37.0
func NewCommonPromQLMatcherType(value CommonPromQLMatcherType) *CommonPromQLMatcherType
func (CommonPromQLMatcherType) ContextValidate ¶ added in v1.37.0
func (m CommonPromQLMatcherType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this common prom q l matcher type based on context it is used
func (CommonPromQLMatcherType) Pointer ¶ added in v1.37.0
func (m CommonPromQLMatcherType) Pointer() *CommonPromQLMatcherType
Pointer returns a pointer to a freshly-allocated CommonPromQLMatcherType.
type Configv1PageResult ¶
type Configv1PageResult struct {
// An opaque page token that identifies the next page of items that the
// client should request. An empty value indicates that there are no
// more items to return.
NextToken string `json:"next_token,omitempty"`
}
Configv1PageResult configv1 page result
swagger:model configv1PageResult
func (*Configv1PageResult) ContextValidate ¶
ContextValidate validates this configv1 page result based on context it is used
func (*Configv1PageResult) MarshalBinary ¶
func (m *Configv1PageResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Configv1PageResult) UnmarshalBinary ¶
func (m *Configv1PageResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Datav1LabelFilter ¶ added in v1.37.0
type Datav1LabelFilter struct {
// match strategy
MatchStrategy LabelFilterMatchStrategy `json:"match_strategy,omitempty"`
// The matchers that make up this clause. An alert must satisfy all of
// them. A filter with no matchers is ignored rather than matching
// everything.
LabelMatchers []*LabelFilterLabelMatcher `json:"label_matchers"`
}
Datav1LabelFilter A set of label matchers evaluated together as a single AND clause.
swagger:model datav1LabelFilter
func (*Datav1LabelFilter) ContextValidate ¶ added in v1.37.0
ContextValidate validate this datav1 label filter based on the context it is used
func (*Datav1LabelFilter) MarshalBinary ¶ added in v1.37.0
func (m *Datav1LabelFilter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Datav1LabelFilter) UnmarshalBinary ¶ added in v1.37.0
func (m *Datav1LabelFilter) 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 LabelFilterLabelMatcher ¶ added in v1.37.0
type LabelFilterLabelMatcher struct {
// filter target
FilterTarget LabelMatcherFilterTarget `json:"filter_target,omitempty"`
// matcher
Matcher *CommonPromQLMatcher `json:"matcher,omitempty"`
}
LabelFilterLabelMatcher One matcher, and which of the alert's two label sets it applies to.
swagger:model LabelFilterLabelMatcher
func (*LabelFilterLabelMatcher) ContextValidate ¶ added in v1.37.0
func (m *LabelFilterLabelMatcher) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this label filter label matcher based on the context it is used
func (*LabelFilterLabelMatcher) MarshalBinary ¶ added in v1.37.0
func (m *LabelFilterLabelMatcher) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LabelFilterLabelMatcher) UnmarshalBinary ¶ added in v1.37.0
func (m *LabelFilterLabelMatcher) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LabelFilterMatchStrategy ¶ added in v1.37.0
type LabelFilterMatchStrategy string
LabelFilterMatchStrategy How closely an alert's labels must correspond to the matchers.
- SUBSET_MATCH: EQUAL matchers require the labels to contain all the given labels, but
the alert may carry more. NOT_EQUAL excludes an alert when the labels match any matcher.
- EXACT_MATCH: EQUAL matchers require exactly the provided labels, no more or less.
NOT_EQUAL excludes an alert only when every NOT_EQUAL matcher applies.
swagger:model LabelFilterMatchStrategy
const ( // LabelFilterMatchStrategySUBSETMATCH captures enum value "SUBSET_MATCH" LabelFilterMatchStrategySUBSETMATCH LabelFilterMatchStrategy = "SUBSET_MATCH" // LabelFilterMatchStrategyEXACTMATCH captures enum value "EXACT_MATCH" LabelFilterMatchStrategyEXACTMATCH LabelFilterMatchStrategy = "EXACT_MATCH" )
func NewLabelFilterMatchStrategy ¶ added in v1.37.0
func NewLabelFilterMatchStrategy(value LabelFilterMatchStrategy) *LabelFilterMatchStrategy
func (LabelFilterMatchStrategy) ContextValidate ¶ added in v1.37.0
func (m LabelFilterMatchStrategy) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this label filter match strategy based on context it is used
func (LabelFilterMatchStrategy) Pointer ¶ added in v1.37.0
func (m LabelFilterMatchStrategy) Pointer() *LabelFilterMatchStrategy
Pointer returns a pointer to a freshly-allocated LabelFilterMatchStrategy.
type LabelMatcherFilterTarget ¶ added in v1.37.0
type LabelMatcherFilterTarget string
LabelMatcherFilterTarget The label set a matcher reads. An alert carries the labels of the signal that fired (`SIGNAL`) and the labels of the monitor or SLO that raised it (`MONITOR`); the two are matched independently.
swagger:model LabelMatcherFilterTarget
const ( // LabelMatcherFilterTargetMONITOR captures enum value "MONITOR" LabelMatcherFilterTargetMONITOR LabelMatcherFilterTarget = "MONITOR" // LabelMatcherFilterTargetSIGNAL captures enum value "SIGNAL" LabelMatcherFilterTargetSIGNAL LabelMatcherFilterTarget = "SIGNAL" )
func NewLabelMatcherFilterTarget ¶ added in v1.37.0
func NewLabelMatcherFilterTarget(value LabelMatcherFilterTarget) *LabelMatcherFilterTarget
func (LabelMatcherFilterTarget) ContextValidate ¶ added in v1.37.0
func (m LabelMatcherFilterTarget) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this label matcher filter target based on context it is used
func (LabelMatcherFilterTarget) Pointer ¶ added in v1.37.0
func (m LabelMatcherFilterTarget) Pointer() *LabelMatcherFilterTarget
Pointer returns a pointer to a freshly-allocated LabelMatcherFilterTarget.
type MetricUsageQueryExecutionCountsByType ¶ added in v1.10.0
type MetricUsageQueryExecutionCountsByType struct {
// explorer
Explorer int32 `json:"explorer,omitempty"`
// dashboard
Dashboard int32 `json:"dashboard,omitempty"`
// external
External int32 `json:"external,omitempty"`
}
MetricUsageQueryExecutionCountsByType metric usage query execution counts by type
swagger:model MetricUsageQueryExecutionCountsByType
func (*MetricUsageQueryExecutionCountsByType) ContextValidate ¶ added in v1.10.0
func (m *MetricUsageQueryExecutionCountsByType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this metric usage query execution counts by type based on context it is used
func (*MetricUsageQueryExecutionCountsByType) MarshalBinary ¶ added in v1.10.0
func (m *MetricUsageQueryExecutionCountsByType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricUsageQueryExecutionCountsByType) UnmarshalBinary ¶ added in v1.10.0
func (m *MetricUsageQueryExecutionCountsByType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MetricUsageReferenceCountsByType ¶ added in v1.10.0
type MetricUsageReferenceCountsByType struct {
// dashboards
Dashboards int32 `json:"dashboards,omitempty"`
// monitors
Monitors int32 `json:"monitors,omitempty"`
// recording rules
RecordingRules int32 `json:"recording_rules,omitempty"`
// drop rules
DropRules int32 `json:"drop_rules,omitempty"`
// aggregation rules
AggregationRules int32 `json:"aggregation_rules,omitempty"`
}
MetricUsageReferenceCountsByType metric usage reference counts by type
swagger:model MetricUsageReferenceCountsByType
func (*MetricUsageReferenceCountsByType) ContextValidate ¶ added in v1.10.0
func (m *MetricUsageReferenceCountsByType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this metric usage reference counts by type based on context it is used
func (*MetricUsageReferenceCountsByType) MarshalBinary ¶ added in v1.10.0
func (m *MetricUsageReferenceCountsByType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MetricUsageReferenceCountsByType) UnmarshalBinary ¶ added in v1.10.0
func (m *MetricUsageReferenceCountsByType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RuleEvaluationRuleType ¶
type RuleEvaluationRuleType string
RuleEvaluationRuleType rule evaluation rule type
swagger:model RuleEvaluationRuleType
const ( // RuleEvaluationRuleTypeMONITOR captures enum value "MONITOR" RuleEvaluationRuleTypeMONITOR RuleEvaluationRuleType = "MONITOR" // RuleEvaluationRuleTypeRECORDING captures enum value "RECORDING" RuleEvaluationRuleTypeRECORDING RuleEvaluationRuleType = "RECORDING" )
func NewRuleEvaluationRuleType ¶
func NewRuleEvaluationRuleType(value RuleEvaluationRuleType) *RuleEvaluationRuleType
func (RuleEvaluationRuleType) ContextValidate ¶
ContextValidate validates this rule evaluation rule type based on context it is used
func (RuleEvaluationRuleType) Pointer ¶
func (m RuleEvaluationRuleType) Pointer() *RuleEvaluationRuleType
Pointer returns a pointer to a freshly-allocated RuleEvaluationRuleType.
type Statev1ListMetricUsagesByLabelNameResponse ¶ added in v1.10.0
type Statev1ListMetricUsagesByLabelNameResponse struct {
// page
Page *Configv1PageResult `json:"page,omitempty"`
// usages
Usages []*Statev1MetricUsageByLabelName `json:"usages"`
}
Statev1ListMetricUsagesByLabelNameResponse statev1 list metric usages by label name response
swagger:model statev1ListMetricUsagesByLabelNameResponse
func (*Statev1ListMetricUsagesByLabelNameResponse) ContextValidate ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByLabelNameResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 list metric usages by label name response based on the context it is used
func (*Statev1ListMetricUsagesByLabelNameResponse) MarshalBinary ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByLabelNameResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1ListMetricUsagesByLabelNameResponse) UnmarshalBinary ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByLabelNameResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1ListMetricUsagesByMetricNameResponse ¶ added in v1.10.0
type Statev1ListMetricUsagesByMetricNameResponse struct {
// page
Page *Configv1PageResult `json:"page,omitempty"`
// usages
Usages []*Statev1MetricUsageByMetricName `json:"usages"`
}
Statev1ListMetricUsagesByMetricNameResponse statev1 list metric usages by metric name response
swagger:model statev1ListMetricUsagesByMetricNameResponse
func (*Statev1ListMetricUsagesByMetricNameResponse) ContextValidate ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByMetricNameResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 list metric usages by metric name response based on the context it is used
func (*Statev1ListMetricUsagesByMetricNameResponse) MarshalBinary ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByMetricNameResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1ListMetricUsagesByMetricNameResponse) UnmarshalBinary ¶ added in v1.10.0
func (m *Statev1ListMetricUsagesByMetricNameResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1ListMonitorStatusesRequest ¶ added in v1.37.0
type Statev1ListMonitorStatusesRequest struct {
// Return only these monitors. When empty, returns every monitor with a firing
// alert.
MonitorSlugs []string `json:"monitor_slugs"`
// Return only monitors owned by one of these collections.
CollectionSlugs []string `json:"collection_slugs"`
// Return only monitors owned by one of these teams.
TeamSlugs []string `json:"team_slugs"`
// Each LabelFilter is one AND clause; the clauses are OR'ed together.
// Applied to alerts before they roll up into monitor statuses, with the same
// semantics as ListAlerts.
LabelFilters []*Datav1LabelFilter `json:"label_filters"`
// severity
Severity Datav1Severity `json:"severity,omitempty"`
// Include each monitor's firing signals.
IncludeSignals bool `json:"include_signals,omitempty"`
}
Statev1ListMonitorStatusesRequest statev1 list monitor statuses request
swagger:model statev1ListMonitorStatusesRequest
func (*Statev1ListMonitorStatusesRequest) ContextValidate ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 list monitor statuses request based on the context it is used
func (*Statev1ListMonitorStatusesRequest) MarshalBinary ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1ListMonitorStatusesRequest) UnmarshalBinary ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1ListMonitorStatusesResponse ¶ added in v1.37.0
type Statev1ListMonitorStatusesResponse struct {
// One entry per monitor with at least one matching firing alert, ordered by
// monitor slug. Monitors that are not firing are omitted.
MonitorStatuses []*Statev1MonitorStatus `json:"monitor_statuses"`
}
Statev1ListMonitorStatusesResponse statev1 list monitor statuses response
swagger:model statev1ListMonitorStatusesResponse
func (*Statev1ListMonitorStatusesResponse) ContextValidate ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 list monitor statuses response based on the context it is used
func (*Statev1ListMonitorStatusesResponse) MarshalBinary ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1ListMonitorStatusesResponse) UnmarshalBinary ¶ added in v1.37.0
func (m *Statev1ListMonitorStatusesResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1ListRuleEvaluationsResponse ¶
type Statev1ListRuleEvaluationsResponse struct {
// page
Page *Configv1PageResult `json:"page,omitempty"`
// rule evaluations
RuleEvaluations []*Statev1RuleEvaluation `json:"rule_evaluations"`
}
Statev1ListRuleEvaluationsResponse statev1 list rule evaluations response
swagger:model statev1ListRuleEvaluationsResponse
func (*Statev1ListRuleEvaluationsResponse) ContextValidate ¶
func (m *Statev1ListRuleEvaluationsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 list rule evaluations response based on the context it is used
func (*Statev1ListRuleEvaluationsResponse) MarshalBinary ¶
func (m *Statev1ListRuleEvaluationsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1ListRuleEvaluationsResponse) UnmarshalBinary ¶
func (m *Statev1ListRuleEvaluationsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1MetricUsage ¶ added in v1.10.0
type Statev1MetricUsage struct {
// total references
TotalReferences int32 `json:"total_references,omitempty"`
// total query executions
TotalQueryExecutions int32 `json:"total_query_executions,omitempty"`
// total unique users
TotalUniqueUsers int32 `json:"total_unique_users,omitempty"`
// utility score
UtilityScore float64 `json:"utility_score,omitempty"`
// reference counts by type
ReferenceCountsByType *MetricUsageReferenceCountsByType `json:"reference_counts_by_type,omitempty"`
// query execution counts by type
QueryExecutionCountsByType *MetricUsageQueryExecutionCountsByType `json:"query_execution_counts_by_type,omitempty"`
}
Statev1MetricUsage statev1 metric usage
swagger:model statev1MetricUsage
func (*Statev1MetricUsage) ContextValidate ¶ added in v1.10.0
ContextValidate validate this statev1 metric usage based on the context it is used
func (*Statev1MetricUsage) MarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsage) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1MetricUsage) UnmarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsage) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1MetricUsageByLabelName ¶ added in v1.10.0
type Statev1MetricUsageByLabelName struct {
// label name
LabelName string `json:"label_name,omitempty"`
// usage
Usage *Statev1MetricUsage `json:"usage,omitempty"`
// total unique values
TotalUniqueValues int32 `json:"total_unique_values,omitempty"`
// dpps
Dpps float64 `json:"dpps,omitempty"`
// Percent of persisted series observed to have the label name.
// Returns in format: [0.0, 100.0]
PercentOfSeriesWithLabelName float64 `json:"percent_of_series_with_label_name,omitempty"`
}
Statev1MetricUsageByLabelName statev1 metric usage by label name
swagger:model statev1MetricUsageByLabelName
func (*Statev1MetricUsageByLabelName) ContextValidate ¶ added in v1.10.0
func (m *Statev1MetricUsageByLabelName) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 metric usage by label name based on the context it is used
func (*Statev1MetricUsageByLabelName) MarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsageByLabelName) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1MetricUsageByLabelName) UnmarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsageByLabelName) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1MetricUsageByMetricName ¶ added in v1.10.0
type Statev1MetricUsageByMetricName struct {
// metric name
MetricName string `json:"metric_name,omitempty"`
// usage
Usage *Statev1MetricUsage `json:"usage,omitempty"`
// dpps
Dpps float64 `json:"dpps,omitempty"`
}
Statev1MetricUsageByMetricName statev1 metric usage by metric name
swagger:model statev1MetricUsageByMetricName
func (*Statev1MetricUsageByMetricName) ContextValidate ¶ added in v1.10.0
func (m *Statev1MetricUsageByMetricName) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this statev1 metric usage by metric name based on the context it is used
func (*Statev1MetricUsageByMetricName) MarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsageByMetricName) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1MetricUsageByMetricName) UnmarshalBinary ¶ added in v1.10.0
func (m *Statev1MetricUsageByMetricName) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1MonitorStatus ¶ added in v1.37.0
type Statev1MonitorStatus struct {
// The slug of the monitor.
MonitorSlug string `json:"monitor_slug,omitempty"`
// True when every firing alert is muted.
Muted bool `json:"muted,omitempty"`
// severity
Severity Datav1Severity `json:"severity,omitempty"`
// The monitor's firing signals, ordered by their labels. Set only with
// `include_signals`.
Signals []*Statev1SignalStatus `json:"signals"`
}
Statev1MonitorStatus The rolled-up state of every firing alert of one monitor.
swagger:model statev1MonitorStatus
func (*Statev1MonitorStatus) ContextValidate ¶ added in v1.37.0
ContextValidate validate this statev1 monitor status based on the context it is used
func (*Statev1MonitorStatus) MarshalBinary ¶ added in v1.37.0
func (m *Statev1MonitorStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1MonitorStatus) UnmarshalBinary ¶ added in v1.37.0
func (m *Statev1MonitorStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1RuleEvaluation ¶
type Statev1RuleEvaluation struct {
// Unique identifier of the rule.
RuleSlug string `json:"rule_slug,omitempty"`
// rule type
RuleType RuleEvaluationRuleType `json:"rule_type,omitempty"`
// Timestamp when the rule evaluation issues are detected.
// Rule evaluations issues are aggregated over last 5 minute leading up to detected_at.
// Format: date-time
DetectedAt strfmt.DateTime `json:"detected_at,omitempty"`
// The number of rule evaluation issues occurred over last 5 minutes.
Count int32 `json:"count,omitempty"`
// Detailed message related to rule evaluation issue. See "Admin > Evaluation failures" in the Palo Alto Networks documentation for more information.
Message string `json:"message,omitempty"`
// severity
Severity Statev1RuleEvaluationSeverity `json:"severity,omitempty"`
}
Statev1RuleEvaluation statev1 rule evaluation
swagger:model statev1RuleEvaluation
func (*Statev1RuleEvaluation) ContextValidate ¶
ContextValidate validate this statev1 rule evaluation based on the context it is used
func (*Statev1RuleEvaluation) MarshalBinary ¶
func (m *Statev1RuleEvaluation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1RuleEvaluation) UnmarshalBinary ¶
func (m *Statev1RuleEvaluation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1RuleEvaluationSeverity ¶ added in v1.37.0
type Statev1RuleEvaluationSeverity string
Statev1RuleEvaluationSeverity Severity of the rule evaluation issue.
- SEVERITY_ERROR: A hard evaluation failure.
- SEVERITY_WARNING: A non-fatal warning; the evaluation succeeded but something needs attention.
swagger:model statev1RuleEvaluationSeverity
const ( // Statev1RuleEvaluationSeveritySEVERITYERROR captures enum value "SEVERITY_ERROR" Statev1RuleEvaluationSeveritySEVERITYERROR Statev1RuleEvaluationSeverity = "SEVERITY_ERROR" // Statev1RuleEvaluationSeveritySEVERITYWARNING captures enum value "SEVERITY_WARNING" Statev1RuleEvaluationSeveritySEVERITYWARNING Statev1RuleEvaluationSeverity = "SEVERITY_WARNING" )
func NewStatev1RuleEvaluationSeverity ¶ added in v1.37.0
func NewStatev1RuleEvaluationSeverity(value Statev1RuleEvaluationSeverity) *Statev1RuleEvaluationSeverity
func (Statev1RuleEvaluationSeverity) ContextValidate ¶ added in v1.37.0
func (m Statev1RuleEvaluationSeverity) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this statev1 rule evaluation severity based on context it is used
func (Statev1RuleEvaluationSeverity) Pointer ¶ added in v1.37.0
func (m Statev1RuleEvaluationSeverity) Pointer() *Statev1RuleEvaluationSeverity
Pointer returns a pointer to a freshly-allocated Statev1RuleEvaluationSeverity.
type Statev1SeverityStatus ¶ added in v1.37.0
type Statev1SeverityStatus struct {
// severity
Severity Datav1Severity `json:"severity,omitempty"`
// Whether notifications for the alert are muted.
Muted bool `json:"muted,omitempty"`
}
Statev1SeverityStatus The firing alert of one severity of a signal.
swagger:model statev1SeverityStatus
func (*Statev1SeverityStatus) ContextValidate ¶ added in v1.37.0
ContextValidate validate this statev1 severity status based on the context it is used
func (*Statev1SeverityStatus) MarshalBinary ¶ added in v1.37.0
func (m *Statev1SeverityStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1SeverityStatus) UnmarshalBinary ¶ added in v1.37.0
func (m *Statev1SeverityStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Statev1SignalStatus ¶ added in v1.37.0
type Statev1SignalStatus struct {
// The labels of the signal.
SignalLabels map[string]string `json:"signal_labels,omitempty"`
// The signal's firing severities, most severe first.
Severities []*Statev1SeverityStatus `json:"severities"`
}
Statev1SignalStatus One firing signal of a monitor.
swagger:model statev1SignalStatus
func (*Statev1SignalStatus) ContextValidate ¶ added in v1.37.0
ContextValidate validate this statev1 signal status based on the context it is used
func (*Statev1SignalStatus) MarshalBinary ¶ added in v1.37.0
func (m *Statev1SignalStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Statev1SignalStatus) UnmarshalBinary ¶ added in v1.37.0
func (m *Statev1SignalStatus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files
¶
- api_error.go
- common_prom_q_l_matcher.go
- common_prom_q_l_matcher_type.go
- configv1_page_result.go
- datav1_label_filter.go
- datav1_severity.go
- label_filter_label_matcher.go
- label_filter_match_strategy.go
- label_matcher_filter_target.go
- metric_usage_query_execution_counts_by_type.go
- metric_usage_reference_counts_by_type.go
- rule_evaluation_rule_type.go
- statev1_list_metric_usages_by_label_name_response.go
- statev1_list_metric_usages_by_metric_name_response.go
- statev1_list_monitor_statuses_request.go
- statev1_list_monitor_statuses_response.go
- statev1_list_rule_evaluations_response.go
- statev1_metric_usage.go
- statev1_metric_usage_by_label_name.go
- statev1_metric_usage_by_metric_name.go
- statev1_monitor_status.go
- statev1_rule_evaluation.go
- statev1_rule_evaluation_severity.go
- statev1_severity_status.go
- statev1_signal_status.go