status

package
v0.9.2 Latest Latest
Warning

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

 Go to latest Published: Aug 20, 2025 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package status is a generated GoMock package.

Index

Constants

View Source 
const (
	MaxMessageLength = 250
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CollectorOpt added in v0.7.0 

type CollectorOpt func(*CollectorOpts)

func WithForceCollect added in v0.7.0 

func WithForceCollect() CollectorOpt

WithForceCollect forces the collection of status information from all exporters.

type CollectorOpts added in v0.7.0 

type CollectorOpts struct {
	// Force forces the collection of status information from all exporters.
	Force bool
}

type Exporter 

type Exporter interface {
	// Status collects status information and updates the device status.
	Status(context.Context, *v1alpha1.DeviceStatus, ...CollectorOpt) error
}

type Getter added in v0.7.0 

type Getter interface {
	// Get returns the device status and is safe to call without a management client.
	Get(context.Context) *v1alpha1.DeviceStatus
}

type Manager 

type Manager interface {
	Getter
	// Sync collects status information from all exporters and updates the device status.
	Sync(context.Context) error
	// Collect gathers status information from all exporters and is safe to call without a management client.
	Collect(context.Context, ...CollectorOpt) error
	// RegisterStatusExporter registers an exporter to be called when collecting status.
	RegisterStatusExporter(Exporter)
	// Update updates the device status with the given update functions.
	Update(ctx context.Context, updateFuncs ...UpdateStatusFn) (*v1alpha1.DeviceStatus, error)
	// UpdateCondition updates the device status with the given condition.
	UpdateCondition(context.Context, v1alpha1.Condition) error
	// SetClient sets the management client for the status manager.
	SetClient(client.Management)
}

type MockExporter 

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

MockExporter is a mock of Exporter interface.

func NewMockExporter 

func NewMockExporter(ctrl *gomock.Controller) *MockExporter

NewMockExporter creates a new mock instance.

func (*MockExporter) EXPECT 

func (m *MockExporter) EXPECT() *MockExporterMockRecorder

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

func (*MockExporter) Status added in v0.4.0 

func (m *MockExporter) Status(arg0 context.Context, arg1 *v1alpha1.DeviceStatus, arg2 ...CollectorOpt) error

Status mocks base method.

type MockExporterMockRecorder 

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

MockExporterMockRecorder is the mock recorder for MockExporter.

func (*MockExporterMockRecorder) Status added in v0.4.0 

func (mr *MockExporterMockRecorder) Status(arg0, arg1 any, arg2 ...any) *gomock.Call

Status indicates an expected call of Status.

type MockGetter added in v0.7.0 

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

MockGetter is a mock of Getter interface.

func NewMockGetter added in v0.7.0 

func NewMockGetter(ctrl *gomock.Controller) *MockGetter

NewMockGetter creates a new mock instance.

func (*MockGetter) EXPECT added in v0.7.0 

func (m *MockGetter) EXPECT() *MockGetterMockRecorder

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

func (*MockGetter) Get added in v0.7.0 

func (m *MockGetter) Get(arg0 context.Context) *v1alpha1.DeviceStatus

Get mocks base method.

type MockGetterMockRecorder added in v0.7.0 

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

MockGetterMockRecorder is the mock recorder for MockGetter.

func (*MockGetterMockRecorder) Get added in v0.7.0 

func (mr *MockGetterMockRecorder) Get(arg0 any) *gomock.Call

Get indicates an expected call of Get.

type MockManager 

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

MockManager is a mock of Manager interface.

func NewMockManager 

func NewMockManager(ctrl *gomock.Controller) *MockManager

NewMockManager creates a new mock instance.

func (*MockManager) Collect 

func (m *MockManager) Collect(arg0 context.Context, arg1 ...CollectorOpt) error

Collect mocks base method.

func (*MockManager) EXPECT 

func (m *MockManager) EXPECT() *MockManagerMockRecorder

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

func (*MockManager) Get 

func (m *MockManager) Get(arg0 context.Context) *v1alpha1.DeviceStatus

Get mocks base method.

func (*MockManager) RegisterStatusExporter added in v0.4.0 

func (m *MockManager) RegisterStatusExporter(arg0 Exporter)

RegisterStatusExporter mocks base method.

func (*MockManager) SetClient 

func (m *MockManager) SetClient(arg0 client.Management)

SetClient mocks base method.

func (*MockManager) Sync 

func (m *MockManager) Sync(arg0 context.Context) error

Sync mocks base method.

func (*MockManager) Update 

func (m *MockManager) Update(ctx context.Context, updateFuncs ...UpdateStatusFn) (*v1alpha1.DeviceStatus, error)

Update mocks base method.

func (*MockManager) UpdateCondition 

func (m *MockManager) UpdateCondition(arg0 context.Context, arg1 v1alpha1.Condition) error

UpdateCondition mocks base method.

type MockManagerMockRecorder 

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

MockManagerMockRecorder is the mock recorder for MockManager.

func (*MockManagerMockRecorder) Collect 

func (mr *MockManagerMockRecorder) Collect(arg0 any, arg1 ...any) *gomock.Call

Collect indicates an expected call of Collect.

func (*MockManagerMockRecorder) Get 

func (mr *MockManagerMockRecorder) Get(arg0 any) *gomock.Call

Get indicates an expected call of Get.

func (*MockManagerMockRecorder) RegisterStatusExporter added in v0.4.0 

func (mr *MockManagerMockRecorder) RegisterStatusExporter(arg0 any) *gomock.Call

RegisterStatusExporter indicates an expected call of RegisterStatusExporter.

func (*MockManagerMockRecorder) SetClient 

func (mr *MockManagerMockRecorder) SetClient(arg0 any) *gomock.Call

SetClient indicates an expected call of SetClient.

func (*MockManagerMockRecorder) Sync 

func (mr *MockManagerMockRecorder) Sync(arg0 any) *gomock.Call

Sync indicates an expected call of Sync.

func (*MockManagerMockRecorder) Update 

func (mr *MockManagerMockRecorder) Update(ctx any, updateFuncs ...any) *gomock.Call

Update indicates an expected call of Update.

func (*MockManagerMockRecorder) UpdateCondition 

func (mr *MockManagerMockRecorder) UpdateCondition(arg0, arg1 any) *gomock.Call

UpdateCondition indicates an expected call of UpdateCondition.

type StatusManager 

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

Collector aggregates device status from various exporters.

func NewManager 

func NewManager(
	deviceName string,
	log *log.PrefixLogger,
) *StatusManager

NewManager creates a new device status manager.

func (*StatusManager) Collect 

func (m *StatusManager) Collect(ctx context.Context, opts ...CollectorOpt) error

func (*StatusManager) Get 

func (m *StatusManager) Get(ctx context.Context) *v1alpha1.DeviceStatus

func (*StatusManager) RegisterStatusExporter added in v0.4.0 

func (m *StatusManager) RegisterStatusExporter(exporter Exporter)

func (*StatusManager) ReloadCollect added in v0.7.0 

func (m *StatusManager) ReloadCollect(ctx context.Context, _ *config.Config) error

ReloadCollect collects status information from all exporters in the case that the agent receives a SIGHUP signal.

func (*StatusManager) SetClient 

func (m *StatusManager) SetClient(managementClient client.Management)

func (*StatusManager) Sync 

func (m *StatusManager) Sync(ctx context.Context) error

func (*StatusManager) Update 

func (m *StatusManager) Update(ctx context.Context, updateFuncs ...UpdateStatusFn) (*v1alpha1.DeviceStatus, error)

func (*StatusManager) UpdateCondition 

func (m *StatusManager) UpdateCondition(ctx context.Context, condition v1alpha1.Condition) error

type UpdateStatusFn 

type UpdateStatusFn func(status *v1alpha1.DeviceStatus) error

func SetConfig 

func SetConfig(configStatus v1alpha1.DeviceConfigStatus) UpdateStatusFn

func SetDeviceSummary 

func SetDeviceSummary(summaryStatus v1alpha1.DeviceSummaryStatus) UpdateStatusFn

func SetOSImage 

func SetOSImage(osStatus v1alpha1.DeviceOsStatus) UpdateStatusFn

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.