clusterstatus

package

v0.3.0 Latest Latest Go to latest Published: Apr 17, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation ¶

Package clusterstatus provides a set of primitives to compose the SetStatusInCluster RPC Response

This section is empty.

View Source

var ErrNilObject = errors.New("nil object passed, use NoOpResponse")

ErrNilObject is used when a nil object is passed to the builder.

This section is empty.

type NotAnObjectError struct {
	// contains filtered or unexported fields
}

NotAnObjectError is used when the passed value cannot be represented as a JSON object.

func (err NotAnObjectError) Error() string

type SetStatusInClusterResponseBuilder struct{}

SetStatusInClusterResponseBuilder a SetStatus response builder.

func NewSetStatusInClusterResponseBuilder() *SetStatusInClusterResponseBuilder

NewSetStatusInClusterResponseBuilder is an helper that creates the SetStatus endpoint responses.

func (s SetStatusInClusterResponseBuilder) JSONStatusResponse(obj any) (*operator.SetStatusInClusterResponse, error)

JSONStatusResponse requires a struct or map that can be translated to a JSON object, will set the status to the passed object.

func (s SetStatusInClusterResponseBuilder) NoOpResponse() *operator.SetStatusInClusterResponse

NoOpResponse this response will ensure that no changes will be done to the plugin status.

func (s SetStatusInClusterResponseBuilder) SetEmptyStatusResponse() *operator.SetStatusInClusterResponse

SetEmptyStatusResponse will set the plugin status to an empty object '{}'.