types

Documentation

Overview

Package types contains structs used by to construct ValidationResults.

Index

• Constants
• type SinkType
• type ValidationResponse
  • func (v *ValidationResponse) AddResult(vrr *ValidationRuleResult, err error)
• type ValidationRuleResult
  • func (vrr *ValidationRuleResult) Finalize(err error)

Constants

const ErrValidationFailed = "Validation failed with an unexpected error"

ErrValidationFailed is the error message returned when a validation rule fails.

Types

type SinkType

type SinkType string

SinkType is the type of sink to which a notification should be sent.

const (
	// SinkTypeAlertmanager is an Alertmanager sink.
	SinkTypeAlertmanager SinkType = "alertmanager"

	// SinkTypeSlack is a Slack sink.
	SinkTypeSlack SinkType = "slack"
)

type ValidationResponse

type ValidationResponse struct {
	ValidationRuleResults []*ValidationRuleResult
	ValidationRuleErrors  []error
}

ValidationResponse is the reconciliation output of one or more validation rules by a validator.

func (*ValidationResponse) AddResult

func (v *ValidationResponse) AddResult(vrr *ValidationRuleResult, err error)

AddResult adds a ValidationRuleResult and associated error to a ValidationResponse.

type ValidationRuleResult

type ValidationRuleResult struct {
	Condition *v1alpha1.ValidationCondition
	State     *v1alpha1.ValidationState
}

ValidationRuleResult is the result of the execution of a validation rule by a validator.

func (*ValidationRuleResult) Finalize

func (vrr *ValidationRuleResult) Finalize(err error)

Finalize sets the ValidationRuleResult state to ValidationFailed if an non-nil error is provided.