reporter

package
v0.34.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 20, 2024 License: Apache-2.0 Imports: 12 Imported by: 15

Documentation

Index

Constants

View Source 
const (
	// 1024 chars = 1kb
	MaxStatusBytes = 1024
	MaxStatusKeys  = 100
)

Variables

View Source 
var (
	// only public for unit tests!
	DisableTruncateStatus = false
)

Functions

This section is empty.

Types

type Report 

type Report struct {
	Warnings []string
	Errors   error

	// Additional information about the current state of the resource.
	Messages []string
}

type Reporter 

type Reporter interface {
	WriteReports(ctx context.Context, errs ResourceReports, subresourceStatuses map[string]*core.Status) error
}

type ReporterResourceClient added in v0.13.9 

type ReporterResourceClient interface {
	Kind() string
	ApplyStatus(statusClient resources.StatusClient, inputResource resources.InputResource, opts clients.ApplyStatusOpts) (resources.Resource, error)
}

Minimal set of client operations required for reporters.

type ResourceReports 

type ResourceReports map[resources.InputResource]Report

func (ResourceReports) Accept 

func (e ResourceReports) Accept(res ...resources.InputResource) ResourceReports

func (ResourceReports) AddError 

func (e ResourceReports) AddError(res resources.InputResource, err error)

func (ResourceReports) AddErrors added in v0.10.25 

func (e ResourceReports) AddErrors(res resources.InputResource, errs ...error)

func (ResourceReports) AddMessage added in v0.28.1 

func (e ResourceReports) AddMessage(res resources.InputResource, message string)

func (ResourceReports) AddMessages added in v0.28.1 

func (e ResourceReports) AddMessages(res resources.InputResource, messages ...string)

func (ResourceReports) AddWarning 

func (e ResourceReports) AddWarning(res resources.InputResource, warning string)

func (ResourceReports) AddWarnings added in v0.10.25 

func (e ResourceReports) AddWarnings(res resources.InputResource, warning ...string)

func (ResourceReports) FilterByKind added in v0.18.3 

func (e ResourceReports) FilterByKind(kind string) ResourceReports

func (ResourceReports) Find added in v0.10.25 

func (e ResourceReports) Find(kind string, ref *core.ResourceRef) (resources.InputResource, Report)

func (ResourceReports) Merge 

func (e ResourceReports) Merge(resErrs ResourceReports)

Merge merges the given resourceReports into this resourceReports. Any resources which appear in both resourceReports will have their warnings and errors merged. Errors appearing in both reports, as determined by the error strings, will not be duplicated in the resulting merged report.

func (ResourceReports) Validate 

func (e ResourceReports) Validate() error

Validate ignores warnings

func (ResourceReports) ValidateStrict 

func (e ResourceReports) ValidateStrict() error

ValidateStrict does not ignore warnings. If warnings are present, they will be included in the error. If an error is not present but warnings are, an "invalid resource" error will be returned along with each warning.

type StatusReporter added in v0.13.13 

type StatusReporter interface {
	Reporter
	StatusFromReport(report Report, subresourceStatuses map[string]*core.Status) *core.Status
}

func NewReporter 

func NewReporter(reporterRef string, statusClient resources.StatusClient, reporterClients ...ReporterResourceClient) StatusReporter

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.