diag

Documentation

Index

• type Description
• type Diagnostic
• type DiagnosticType
  • func (d DiagnosticType) String() string
• type Diagnostics
  • func (dd Diagnostics) Errors() uint64
  • func (dd Diagnostics) Len() int
  • func (dd Diagnostics) Less(i, j int) bool
  • func (dd Diagnostics) Swap(i, j int)
  • func (dd Diagnostics) Warnings() uint64
• type ExecutionError
  • func FromError(err error, severity Severity, dt DiagnosticType, ...) *ExecutionError
  • func (e ExecutionError) Description() Description
  • func (e ExecutionError) Error() string
  • func (e ExecutionError) Severity() Severity
  • func (e ExecutionError) Type() DiagnosticType
• type Severity

Types

type Description

type Description struct {
	Resource string
	Summary  string
	Detail   string
}

type Diagnostic

type Diagnostic interface {
	Severity() Severity
	Type() DiagnosticType
	Description() Description
}

type DiagnosticType

type DiagnosticType int

const (
	Unknown DiagnosticType = iota
	RESOLVING
	ACCESS
	THROTTLE
	DATABASE
)

func (DiagnosticType) String

func (d DiagnosticType) String() string

type Diagnostics

type Diagnostics []Diagnostic

func (Diagnostics) Errors

func (dd Diagnostics) Errors() uint64

func (Diagnostics) Len

func (dd Diagnostics) Len() int

func (Diagnostics) Less

func (dd Diagnostics) Less(i, j int) bool

func (Diagnostics) Swap

func (dd Diagnostics) Swap(i, j int)

func (Diagnostics) Warnings

func (dd Diagnostics) Warnings() uint64

type ExecutionError

type ExecutionError struct {
	// Err is the underlying go error this diagnostic wraps
	Err error
	// contains filtered or unexported fields
}

ExecutionError is a generic error returned when execution is run, ExecutionError satisfies

func FromError

func FromError(err error, severity Severity, dt DiagnosticType, resource, summary, details string) *ExecutionError

FromError creates an ExecutionError from given error

func (ExecutionError) Description

func (e ExecutionError) Description() Description

func (ExecutionError) Error

func (e ExecutionError) Error() string

func (ExecutionError) Severity

func (e ExecutionError) Severity() Severity

func (ExecutionError) Type

func (e ExecutionError) Type() DiagnosticType

type Severity

type Severity int

const (
	// IGNORE severity is set for diagnostics that were ignored by the SDK
	IGNORE Severity = iota
	// WARNING severity are diagnostics that should be fixed but aren't fatal to the fetch execution
	WARNING
	// ERROR severity are diagnostics that were fatal in the fetch execution and should be fixed.
	ERROR
)