Documentation ¶
Index ¶
- func NewCommandClient(baseUrl string) interfaces.CommandClient
- func NewCommonClient(baseUrl string) interfaces.CommonClient
- func NewDeviceClient(baseUrl string) interfaces.DeviceClient
- func NewDeviceProfileClient(baseUrl string) interfaces.DeviceProfileClient
- func NewDeviceServiceCallbackClient(baseUrl string) interfaces.DeviceServiceCallbackClient
- func NewDeviceServiceClient(baseUrl string) interfaces.DeviceServiceClient
- func NewDeviceServiceCommandClient() interfaces.DeviceServiceCommandClient
- func NewEventClient(baseUrl string) interfaces.EventClient
- func NewGeneralClient(baseUrl string) interfaces.GeneralClient
- func NewIntervalActionClient(baseUrl string) interfaces.IntervalActionClient
- func NewIntervalClient(baseUrl string) interfaces.IntervalClient
- func NewProvisionWatcherClient(baseUrl string) interfaces.ProvisionWatcherClient
- func NewReadingClient(baseUrl string) interfaces.ReadingClient
- type CommandClient
- func (client *CommandClient) AllDeviceCoreCommands(ctx context.Context, offset int, limit int) (res responses.MultiDeviceCoreCommandsResponse, err errors.EdgeX)
- func (client *CommandClient) DeviceCoreCommandsByDeviceName(ctx context.Context, name string) (res responses.DeviceCoreCommandResponse, err errors.EdgeX)
- func (client *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent string, ...) (res *responses.EventResponse, err errors.EdgeX)
- func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, ...) (res common.BaseResponse, err errors.EdgeX)
- type DeviceClient
- func (dc DeviceClient) Add(ctx context.Context, reqs []requests.AddDeviceRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
- func (dc DeviceClient) AllDevices(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
- func (dc DeviceClient) DeleteDeviceByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (dc DeviceClient) DeviceByName(ctx context.Context, name string) (res responses.DeviceResponse, err errors.EdgeX)
- func (dc DeviceClient) DeviceNameExists(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (dc DeviceClient) DevicesByProfileName(ctx context.Context, name string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
- func (dc DeviceClient) DevicesByServiceName(ctx context.Context, name string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
- func (dc DeviceClient) Update(ctx context.Context, reqs []requests.UpdateDeviceRequest) (res []common.BaseResponse, err errors.EdgeX)
- type DeviceProfileClient
- func (client *DeviceProfileClient) Add(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseWithIdResponse, errors.EdgeX)
- func (client *DeviceProfileClient) AddByYaml(ctx context.Context, yamlFilePath string) (common.BaseWithIdResponse, errors.EdgeX)
- func (client *DeviceProfileClient) AllDeviceProfiles(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) CleanResourcesCache()
- func (client *DeviceProfileClient) DeleteByName(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)
- func (client *DeviceProfileClient) DeviceProfileByName(ctx context.Context, name string) (res responses.DeviceProfileResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) DeviceProfilesByManufacturer(ctx context.Context, manufacturer string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) DeviceProfilesByManufacturerAndModel(ctx context.Context, manufacturer string, model string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) DeviceProfilesByModel(ctx context.Context, model string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) DeviceResourceByProfileNameAndResourceName(ctx context.Context, profileName string, resourceName string) (res responses.DeviceResourceResponse, edgexError errors.EdgeX)
- func (client *DeviceProfileClient) Update(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseResponse, errors.EdgeX)
- func (client *DeviceProfileClient) UpdateByYaml(ctx context.Context, yamlFilePath string) (common.BaseResponse, errors.EdgeX)
- type DeviceServiceClient
- func (dsc DeviceServiceClient) Add(ctx context.Context, reqs []requests.AddDeviceServiceRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
- func (dsc DeviceServiceClient) AllDeviceServices(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDeviceServicesResponse, err errors.EdgeX)
- func (dsc DeviceServiceClient) DeleteByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (dsc DeviceServiceClient) DeviceServiceByName(ctx context.Context, name string) (res responses.DeviceServiceResponse, err errors.EdgeX)
- func (dsc DeviceServiceClient) Update(ctx context.Context, reqs []requests.UpdateDeviceServiceRequest) (res []common.BaseResponse, err errors.EdgeX)
- type IntervalActionClient
- func (client IntervalActionClient) Add(ctx context.Context, reqs []requests.AddIntervalActionRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
- func (client IntervalActionClient) AllIntervalActions(ctx context.Context, offset int, limit int) (res responses.MultiIntervalActionsResponse, err errors.EdgeX)
- func (client IntervalActionClient) DeleteIntervalActionByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (client IntervalActionClient) IntervalActionByName(ctx context.Context, name string) (res responses.IntervalActionResponse, err errors.EdgeX)
- func (client IntervalActionClient) Update(ctx context.Context, reqs []requests.UpdateIntervalActionRequest) (res []common.BaseResponse, err errors.EdgeX)
- type IntervalClient
- func (client IntervalClient) Add(ctx context.Context, reqs []requests.AddIntervalRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
- func (client IntervalClient) AllIntervals(ctx context.Context, offset int, limit int) (res responses.MultiIntervalsResponse, err errors.EdgeX)
- func (client IntervalClient) DeleteIntervalByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (client IntervalClient) IntervalByName(ctx context.Context, name string) (res responses.IntervalResponse, err errors.EdgeX)
- func (client IntervalClient) Update(ctx context.Context, reqs []requests.UpdateIntervalRequest) (res []common.BaseResponse, err errors.EdgeX)
- type ProvisionWatcherClient
- func (pwc ProvisionWatcherClient) Add(ctx context.Context, reqs []requests.AddProvisionWatcherRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) AllProvisionWatchers(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) DeleteProvisionWatcherByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) ProvisionWatcherByName(ctx context.Context, name string) (res responses.ProvisionWatcherResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) ProvisionWatchersByProfileName(ctx context.Context, name string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) ProvisionWatchersByServiceName(ctx context.Context, name string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
- func (pwc ProvisionWatcherClient) Update(ctx context.Context, reqs []requests.UpdateProvisionWatcherRequest) (res []common.BaseResponse, err errors.EdgeX)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCommandClient ¶
func NewCommandClient(baseUrl string) interfaces.CommandClient
NewCommandClient creates an instance of CommandClient
func NewCommonClient ¶
func NewCommonClient(baseUrl string) interfaces.CommonClient
NewCommonClient creates an instance of CommonClient
func NewDeviceClient ¶
func NewDeviceClient(baseUrl string) interfaces.DeviceClient
NewDeviceClient creates an instance of DeviceClient
func NewDeviceProfileClient ¶
func NewDeviceProfileClient(baseUrl string) interfaces.DeviceProfileClient
NewDeviceProfileClient creates an instance of DeviceProfileClient
func NewDeviceServiceCallbackClient ¶
func NewDeviceServiceCallbackClient(baseUrl string) interfaces.DeviceServiceCallbackClient
NewDeviceServiceCallbackClient creates an instance of deviceServiceCallbackClient
func NewDeviceServiceClient ¶
func NewDeviceServiceClient(baseUrl string) interfaces.DeviceServiceClient
NewDeviceServiceClient creates an instance of DeviceServiceClient
func NewDeviceServiceCommandClient ¶
func NewDeviceServiceCommandClient() interfaces.DeviceServiceCommandClient
NewDeviceServiceCommandClient creates an instance of deviceServiceCommandClient
func NewEventClient ¶
func NewEventClient(baseUrl string) interfaces.EventClient
NewEventClient creates an instance of EventClient
func NewGeneralClient ¶
func NewGeneralClient(baseUrl string) interfaces.GeneralClient
func NewIntervalActionClient ¶
func NewIntervalActionClient(baseUrl string) interfaces.IntervalActionClient
NewIntervalActionClient creates an instance of IntervalActionClient
func NewIntervalClient ¶
func NewIntervalClient(baseUrl string) interfaces.IntervalClient
NewIntervalClient creates an instance of IntervalClient
func NewProvisionWatcherClient ¶
func NewProvisionWatcherClient(baseUrl string) interfaces.ProvisionWatcherClient
NewProvisionWatcherClient creates an instance of ProvisionWatcherClient
func NewReadingClient ¶
func NewReadingClient(baseUrl string) interfaces.ReadingClient
NewReadingClient creates an instance of ReadingClient
Types ¶
type CommandClient ¶
type CommandClient struct {
// contains filtered or unexported fields
}
func (*CommandClient) AllDeviceCoreCommands ¶
func (client *CommandClient) AllDeviceCoreCommands(ctx context.Context, offset int, limit int) ( res responses.MultiDeviceCoreCommandsResponse, err errors.EdgeX)
AllDeviceCoreCommands returns a paginated list of MultiDeviceCoreCommandsResponse. The list contains all of the commands in the system associated with their respective device.
func (*CommandClient) DeviceCoreCommandsByDeviceName ¶
func (client *CommandClient) DeviceCoreCommandsByDeviceName(ctx context.Context, name string) ( res responses.DeviceCoreCommandResponse, err errors.EdgeX)
DeviceCoreCommandsByDeviceName returns all commands associated with the specified device name.
func (*CommandClient) IssueGetCommandByName ¶
func (client *CommandClient) IssueGetCommandByName(ctx context.Context, deviceName string, commandName string, dsPushEvent string, dsReturnEvent string) (res *responses.EventResponse, err errors.EdgeX)
IssueGetCommandByName issues the specified read command referenced by the command name to the device/sensor that is also referenced by name.
func (*CommandClient) IssueSetCommandByName ¶
func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]string) (res common.BaseResponse, err errors.EdgeX)
IssueSetCommandByName issues the specified write command referenced by the command name to the device/sensor that is also referenced by name.
type DeviceClient ¶
type DeviceClient struct {
// contains filtered or unexported fields
}
func (DeviceClient) Add ¶
func (dc DeviceClient) Add(ctx context.Context, reqs []requests.AddDeviceRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
func (DeviceClient) AllDevices ¶
func (dc DeviceClient) AllDevices(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
func (DeviceClient) DeleteDeviceByName ¶
func (dc DeviceClient) DeleteDeviceByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
func (DeviceClient) DeviceByName ¶
func (dc DeviceClient) DeviceByName(ctx context.Context, name string) (res responses.DeviceResponse, err errors.EdgeX)
func (DeviceClient) DeviceNameExists ¶
func (dc DeviceClient) DeviceNameExists(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
func (DeviceClient) DevicesByProfileName ¶
func (dc DeviceClient) DevicesByProfileName(ctx context.Context, name string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
func (DeviceClient) DevicesByServiceName ¶
func (dc DeviceClient) DevicesByServiceName(ctx context.Context, name string, offset int, limit int) (res responses.MultiDevicesResponse, err errors.EdgeX)
func (DeviceClient) Update ¶
func (dc DeviceClient) Update(ctx context.Context, reqs []requests.UpdateDeviceRequest) (res []common.BaseResponse, err errors.EdgeX)
type DeviceProfileClient ¶
type DeviceProfileClient struct {
// contains filtered or unexported fields
}
func (*DeviceProfileClient) Add ¶
func (client *DeviceProfileClient) Add(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseWithIdResponse, errors.EdgeX)
Add adds new device profile
func (*DeviceProfileClient) AddByYaml ¶
func (client *DeviceProfileClient) AddByYaml(ctx context.Context, yamlFilePath string) (common.BaseWithIdResponse, errors.EdgeX)
AddByYaml adds new device profile by uploading a yaml file
func (*DeviceProfileClient) AllDeviceProfiles ¶
func (client *DeviceProfileClient) AllDeviceProfiles(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
AllDeviceProfiles queries the device profiles with offset, and limit
func (*DeviceProfileClient) CleanResourcesCache ¶
func (client *DeviceProfileClient) CleanResourcesCache()
func (*DeviceProfileClient) DeleteByName ¶
func (client *DeviceProfileClient) DeleteByName(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)
DeleteByName deletes the device profile by name
func (*DeviceProfileClient) DeviceProfileByName ¶
func (client *DeviceProfileClient) DeviceProfileByName(ctx context.Context, name string) (res responses.DeviceProfileResponse, edgexError errors.EdgeX)
DeviceProfileByName queries the device profile by name
func (*DeviceProfileClient) DeviceProfilesByManufacturer ¶
func (client *DeviceProfileClient) DeviceProfilesByManufacturer(ctx context.Context, manufacturer string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
DeviceProfilesByManufacturer queries the device profiles with offset, limit and manufacturer
func (*DeviceProfileClient) DeviceProfilesByManufacturerAndModel ¶
func (client *DeviceProfileClient) DeviceProfilesByManufacturerAndModel(ctx context.Context, manufacturer string, model string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
DeviceProfilesByManufacturerAndModel queries the device profiles with offset, limit, manufacturer and model
func (*DeviceProfileClient) DeviceProfilesByModel ¶
func (client *DeviceProfileClient) DeviceProfilesByModel(ctx context.Context, model string, offset int, limit int) (res responses.MultiDeviceProfilesResponse, edgexError errors.EdgeX)
DeviceProfilesByModel queries the device profiles with offset, limit and model
func (*DeviceProfileClient) DeviceResourceByProfileNameAndResourceName ¶
func (client *DeviceProfileClient) DeviceResourceByProfileNameAndResourceName(ctx context.Context, profileName string, resourceName string) (res responses.DeviceResourceResponse, edgexError errors.EdgeX)
DeviceResourceByProfileNameAndResourceName queries the device resource by profileName and resourceName
func (*DeviceProfileClient) Update ¶
func (client *DeviceProfileClient) Update(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseResponse, errors.EdgeX)
Update updates device profile
func (*DeviceProfileClient) UpdateByYaml ¶
func (client *DeviceProfileClient) UpdateByYaml(ctx context.Context, yamlFilePath string) (common.BaseResponse, errors.EdgeX)
UpdateByYaml updates device profile by uploading a yaml file
type DeviceServiceClient ¶
type DeviceServiceClient struct {
// contains filtered or unexported fields
}
func (DeviceServiceClient) Add ¶
func (dsc DeviceServiceClient) Add(ctx context.Context, reqs []requests.AddDeviceServiceRequest) ( res []common.BaseWithIdResponse, err errors.EdgeX)
func (DeviceServiceClient) AllDeviceServices ¶
func (dsc DeviceServiceClient) AllDeviceServices(ctx context.Context, labels []string, offset int, limit int) ( res responses.MultiDeviceServicesResponse, err errors.EdgeX)
func (DeviceServiceClient) DeleteByName ¶
func (dsc DeviceServiceClient) DeleteByName(ctx context.Context, name string) ( res common.BaseResponse, err errors.EdgeX)
func (DeviceServiceClient) DeviceServiceByName ¶
func (dsc DeviceServiceClient) DeviceServiceByName(ctx context.Context, name string) ( res responses.DeviceServiceResponse, err errors.EdgeX)
func (DeviceServiceClient) Update ¶
func (dsc DeviceServiceClient) Update(ctx context.Context, reqs []requests.UpdateDeviceServiceRequest) ( res []common.BaseResponse, err errors.EdgeX)
type IntervalActionClient ¶
type IntervalActionClient struct {
// contains filtered or unexported fields
}
func (IntervalActionClient) Add ¶
func (client IntervalActionClient) Add(ctx context.Context, reqs []requests.AddIntervalActionRequest) ( res []common.BaseWithIdResponse, err errors.EdgeX)
Add adds new intervalActions
func (IntervalActionClient) AllIntervalActions ¶
func (client IntervalActionClient) AllIntervalActions(ctx context.Context, offset int, limit int) ( res responses.MultiIntervalActionsResponse, err errors.EdgeX)
AllIntervalActions query the intervalActions with offset, limit
func (IntervalActionClient) DeleteIntervalActionByName ¶
func (client IntervalActionClient) DeleteIntervalActionByName(ctx context.Context, name string) ( res common.BaseResponse, err errors.EdgeX)
DeleteIntervalActionByName delete the intervalAction by name
func (IntervalActionClient) IntervalActionByName ¶
func (client IntervalActionClient) IntervalActionByName(ctx context.Context, name string) ( res responses.IntervalActionResponse, err errors.EdgeX)
IntervalActionByName query the intervalAction by name
func (IntervalActionClient) Update ¶
func (client IntervalActionClient) Update(ctx context.Context, reqs []requests.UpdateIntervalActionRequest) ( res []common.BaseResponse, err errors.EdgeX)
Update updates intervalActions
type IntervalClient ¶
type IntervalClient struct {
// contains filtered or unexported fields
}
func (IntervalClient) Add ¶
func (client IntervalClient) Add(ctx context.Context, reqs []requests.AddIntervalRequest) ( res []common.BaseWithIdResponse, err errors.EdgeX)
Add adds new intervals
func (IntervalClient) AllIntervals ¶
func (client IntervalClient) AllIntervals(ctx context.Context, offset int, limit int) ( res responses.MultiIntervalsResponse, err errors.EdgeX)
AllIntervals query the intervals with offset, limit
func (IntervalClient) DeleteIntervalByName ¶
func (client IntervalClient) DeleteIntervalByName(ctx context.Context, name string) ( res common.BaseResponse, err errors.EdgeX)
DeleteIntervalByName delete the interval by name
func (IntervalClient) IntervalByName ¶
func (client IntervalClient) IntervalByName(ctx context.Context, name string) ( res responses.IntervalResponse, err errors.EdgeX)
IntervalByName query the interval by name
func (IntervalClient) Update ¶
func (client IntervalClient) Update(ctx context.Context, reqs []requests.UpdateIntervalRequest) ( res []common.BaseResponse, err errors.EdgeX)
Update updates intervals
type ProvisionWatcherClient ¶
type ProvisionWatcherClient struct {
// contains filtered or unexported fields
}
func (ProvisionWatcherClient) Add ¶
func (pwc ProvisionWatcherClient) Add(ctx context.Context, reqs []requests.AddProvisionWatcherRequest) (res []common.BaseWithIdResponse, err errors.EdgeX)
func (ProvisionWatcherClient) AllProvisionWatchers ¶
func (pwc ProvisionWatcherClient) AllProvisionWatchers(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
func (ProvisionWatcherClient) DeleteProvisionWatcherByName ¶
func (pwc ProvisionWatcherClient) DeleteProvisionWatcherByName(ctx context.Context, name string) (res common.BaseResponse, err errors.EdgeX)
func (ProvisionWatcherClient) ProvisionWatcherByName ¶
func (pwc ProvisionWatcherClient) ProvisionWatcherByName(ctx context.Context, name string) (res responses.ProvisionWatcherResponse, err errors.EdgeX)
func (ProvisionWatcherClient) ProvisionWatchersByProfileName ¶
func (pwc ProvisionWatcherClient) ProvisionWatchersByProfileName(ctx context.Context, name string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
func (ProvisionWatcherClient) ProvisionWatchersByServiceName ¶
func (pwc ProvisionWatcherClient) ProvisionWatchersByServiceName(ctx context.Context, name string, offset int, limit int) (res responses.MultiProvisionWatchersResponse, err errors.EdgeX)
func (ProvisionWatcherClient) Update ¶
func (pwc ProvisionWatcherClient) Update(ctx context.Context, reqs []requests.UpdateProvisionWatcherRequest) (res []common.BaseResponse, err errors.EdgeX)