interfaces

Documentation

Index

• type DeviceStatusClient

Types

type DeviceStatusClient

type DeviceStatusClient interface {
	// Update updates the device status.
	Update(ctx context.Context, req requests.UpdateDeviceStatusRequest) (common.BaseResponse, errors.EdgeX)
	// AllDeviceStatus returns all device status.
	// The result can be limited in a certain range by specifying the offset and limit parameters.
	// offset: The number of items to skip before starting to collect the result set. Default is 0.
	// limit: The number of items to return. Specify -1 will return all remaining items after offset.
	// The maximum will be the MaxResultCount as defined in the configuration of service. Default is 20.
	AllDeviceStatus(ctx context.Context, offset int, limit int) (responses.MultiDeviceStatusResponse, errors.EdgeX)
	// DeviceStatusByName returns a device status by device name.
	DeviceStatusByName(ctx context.Context, name string) (responses.DeviceStatusResponse, errors.EdgeX)
}

DeviceStatusClient defines the interface for interactions with the DeviceStatus on the EdgeX Foundry core-metadata service.