health

Documentation

Overview

Package health is a generated GoMock package.

Index

• Variables
• type HealthInformer
  • func NewHealthInformer(ctx context.Context, restConfig *rest.Config, informerType HealthInformerType) (HealthInformer, error)
• type HealthInformerType
• type HealthStatus
• type MockHealthInformer
  • func NewMockHealthInformer(ctrl *gomock.Controller) *MockHealthInformer
  • func (m *MockHealthInformer) EXPECT() *MockHealthInformerMockRecorder
  • func (m *MockHealthInformer) Register(ctx context.Context, model string, resource v1.ObjectReference)
  • func (m *MockHealthInformer) Start(ctx context.Context) <-chan HealthStatus
  • func (m *MockHealthInformer) Stop()
  • func (m *MockHealthInformer) Unregister(ctx context.Context, model string)
• type MockHealthInformerMockRecorder
  • func (mr *MockHealthInformerMockRecorder) Register(ctx, model, resource any) *gomock.Call
  • func (mr *MockHealthInformerMockRecorder) Start(ctx any) *gomock.Call
  • func (mr *MockHealthInformerMockRecorder) Stop() *gomock.Call
  • func (mr *MockHealthInformerMockRecorder) Unregister(ctx, model any) *gomock.Call

Variables

var (
	ErrUnknownInformerType = errors.New("unknown health informer type")
)

Types

type HealthInformer

type HealthInformer interface {
	// Start is non-blocking. It returns a channel that sends the health status of the local model when it changes.
	Start(ctx context.Context) <-chan HealthStatus
	// Register a model to the health informer. Resource is the resource that the model is running on.
	Register(ctx context.Context, model string, resource v1.ObjectReference)
	Unregister(ctx context.Context, model string)
	// Stop stops the health informer.
	Stop()
}

HealthInformer informs on the health of the source model.

func NewHealthInformer

func NewHealthInformer(ctx context.Context, restConfig *rest.Config, informerType HealthInformerType) (HealthInformer, error)

NewHealthInformer creates a new HealthInformer for a given type If the informer does not exist, it returns an error

type HealthInformerType

type HealthInformerType int

const (
	K8SHealthInformerType HealthInformerType = iota
)

type HealthStatus

type HealthStatus struct {
	ModelName string
	Healthy   bool
}

type MockHealthInformer

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

MockHealthInformer is a mock of HealthInformer interface.

func NewMockHealthInformer

func NewMockHealthInformer(ctrl *gomock.Controller) *MockHealthInformer

NewMockHealthInformer creates a new mock instance.

func (*MockHealthInformer) EXPECT

func (m *MockHealthInformer) EXPECT() *MockHealthInformerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockHealthInformer) Register

func (m *MockHealthInformer) Register(ctx context.Context, model string, resource v1.ObjectReference)

Register mocks base method.

func (*MockHealthInformer) Start

func (m *MockHealthInformer) Start(ctx context.Context) <-chan HealthStatus

Start mocks base method.

func (*MockHealthInformer) Stop

func (m *MockHealthInformer) Stop()

Stop mocks base method.

func (*MockHealthInformer) Unregister

func (m *MockHealthInformer) Unregister(ctx context.Context, model string)

Unregister mocks base method.

type MockHealthInformerMockRecorder

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

MockHealthInformerMockRecorder is the mock recorder for MockHealthInformer.

func (*MockHealthInformerMockRecorder) Register

func (mr *MockHealthInformerMockRecorder) Register(ctx, model, resource any) *gomock.Call

Register indicates an expected call of Register.

func (*MockHealthInformerMockRecorder) Start

func (mr *MockHealthInformerMockRecorder) Start(ctx any) *gomock.Call

Start indicates an expected call of Start.

func (*MockHealthInformerMockRecorder) Stop

func (mr *MockHealthInformerMockRecorder) Stop() *gomock.Call

Stop indicates an expected call of Stop.

func (*MockHealthInformerMockRecorder) Unregister

func (mr *MockHealthInformerMockRecorder) Unregister(ctx, model any) *gomock.Call

Unregister indicates an expected call of Unregister.