interfaces

May 23, 2023

Changes in this version

+ type AuthenticationInjector interface

+ AddAuthenticationData func(_ *http.Request) error

+ type CommandClient interface

+ AllDeviceCoreCommands func(ctx context.Context, offset int, limit int) (responses.MultiDeviceCoreCommandsResponse, errors.EdgeX)

+ DeviceCoreCommandsByDeviceName func(ctx context.Context, deviceName string) (responses.DeviceCoreCommandResponse, errors.EdgeX)

+ IssueGetCommandByName func(ctx context.Context, deviceName string, commandName string, dsPushEvent bool, ...) (*responses.EventResponse, errors.EdgeX)

+ IssueGetCommandByNameWithQueryParams func(ctx context.Context, deviceName string, commandName string, ...) (*responses.EventResponse, errors.EdgeX)

+ IssueSetCommandByName func(ctx context.Context, deviceName string, commandName string, ...) (common.BaseResponse, errors.EdgeX)

+ IssueSetCommandByNameWithObject func(ctx context.Context, deviceName string, commandName string, ...) (common.BaseResponse, errors.EdgeX)

+ type CommonClient interface

+ AddSecret func(ctx context.Context, request common.SecretRequest) (common.BaseResponse, errors.EdgeX)

+ Configuration func(ctx context.Context) (common.ConfigResponse, errors.EdgeX)

+ Ping func(ctx context.Context) (common.PingResponse, errors.EdgeX)

+ Version func(ctx context.Context) (common.VersionResponse, errors.EdgeX)

+ type DeviceClient interface

+ Add func(ctx context.Context, reqs []requests.AddDeviceRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllDevices func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiDevicesResponse, errors.EdgeX)

+ DeleteDeviceByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ DeviceByName func(ctx context.Context, name string) (responses.DeviceResponse, errors.EdgeX)

+ DeviceNameExists func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ DevicesByProfileName func(ctx context.Context, name string, offset int, limit int) (responses.MultiDevicesResponse, errors.EdgeX)

+ DevicesByServiceName func(ctx context.Context, name string, offset int, limit int) (responses.MultiDevicesResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateDeviceRequest) ([]common.BaseResponse, errors.EdgeX)

+ type DeviceProfileClient interface

+ Add func(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AddByYaml func(ctx context.Context, yamlFilePath string) (common.BaseWithIdResponse, errors.EdgeX)

+ AddDeviceProfileDeviceCommand func(ctx context.Context, reqs []requests.AddDeviceCommandRequest) ([]common.BaseResponse, errors.EdgeX)

+ AddDeviceProfileResource func(ctx context.Context, reqs []requests.AddDeviceResourceRequest) ([]common.BaseResponse, errors.EdgeX)

+ AllDeviceProfiles func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiDeviceProfilesResponse, errors.EdgeX)

+ DeleteByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ DeleteDeviceCommandByName func(ctx context.Context, profileName string, commandName string) (common.BaseResponse, errors.EdgeX)

+ DeleteDeviceResourceByName func(ctx context.Context, profileName string, resourceName string) (common.BaseResponse, errors.EdgeX)

+ DeviceProfileByName func(ctx context.Context, name string) (responses.DeviceProfileResponse, errors.EdgeX)

+ DeviceProfilesByManufacturer func(ctx context.Context, manufacturer string, offset int, limit int) (responses.MultiDeviceProfilesResponse, errors.EdgeX)

+ DeviceProfilesByManufacturerAndModel func(ctx context.Context, manufacturer string, model string, offset int, limit int) (responses.MultiDeviceProfilesResponse, errors.EdgeX)

+ DeviceProfilesByModel func(ctx context.Context, model string, offset int, limit int) (responses.MultiDeviceProfilesResponse, errors.EdgeX)

+ DeviceResourceByProfileNameAndResourceName func(ctx context.Context, profileName string, resourceName string) (responses.DeviceResourceResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]common.BaseResponse, errors.EdgeX)

+ UpdateByYaml func(ctx context.Context, yamlFilePath string) (common.BaseResponse, errors.EdgeX)

+ UpdateDeviceProfileBasicInfo func(ctx context.Context, reqs []requests.DeviceProfileBasicInfoRequest) ([]common.BaseResponse, errors.EdgeX)

+ UpdateDeviceProfileDeviceCommand func(ctx context.Context, reqs []requests.UpdateDeviceCommandRequest) ([]common.BaseResponse, errors.EdgeX)

+ UpdateDeviceProfileResource func(ctx context.Context, reqs []requests.UpdateDeviceResourceRequest) ([]common.BaseResponse, errors.EdgeX)

+ type DeviceServiceCallbackClient interface

+ AddDeviceCallback func(ctx context.Context, request requests.AddDeviceRequest) (common.BaseResponse, errors.EdgeX)

+ AddProvisionWatcherCallback func(ctx context.Context, request requests.AddProvisionWatcherRequest) (common.BaseResponse, errors.EdgeX)

+ DeleteDeviceCallback func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ DeleteProvisionWatcherCallback func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ UpdateDeviceCallback func(ctx context.Context, request requests.UpdateDeviceRequest) (common.BaseResponse, errors.EdgeX)

+ UpdateDeviceProfileCallback func(ctx context.Context, request requests.DeviceProfileRequest) (common.BaseResponse, errors.EdgeX)

+ UpdateDeviceServiceCallback func(ctx context.Context, request requests.UpdateDeviceServiceRequest) (common.BaseResponse, errors.EdgeX)

+ UpdateProvisionWatcherCallback func(ctx context.Context, request requests.UpdateProvisionWatcherRequest) (common.BaseResponse, errors.EdgeX)

+ ValidateDeviceCallback func(ctx context.Context, request requests.AddDeviceRequest) (common.BaseResponse, errors.EdgeX)

+ type DeviceServiceClient interface

+ Add func(ctx context.Context, reqs []requests.AddDeviceServiceRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllDeviceServices func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiDeviceServicesResponse, errors.EdgeX)

+ DeleteByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ DeviceServiceByName func(ctx context.Context, name string) (responses.DeviceServiceResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateDeviceServiceRequest) ([]common.BaseResponse, errors.EdgeX)

+ type DeviceServiceCommandClient interface

+ GetCommand func(ctx context.Context, baseUrl string, deviceName string, commandName string, ...) (*responses.EventResponse, errors.EdgeX)

+ SetCommand func(ctx context.Context, baseUrl string, deviceName string, commandName string, ...) (common.BaseResponse, errors.EdgeX)

+ SetCommandWithObject func(ctx context.Context, baseUrl string, deviceName string, commandName string, ...) (common.BaseResponse, errors.EdgeX)

+ type EventClient interface

+ Add func(ctx context.Context, serviceName string, req requests.AddEventRequest) (common.BaseWithIdResponse, errors.EdgeX)

+ AllEvents func(ctx context.Context, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX)

+ DeleteByAge func(ctx context.Context, age int) (common.BaseResponse, errors.EdgeX)

+ DeleteByDeviceName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ EventCount func(ctx context.Context) (common.CountResponse, errors.EdgeX)

+ EventCountByDeviceName func(ctx context.Context, name string) (common.CountResponse, errors.EdgeX)

+ EventsByDeviceName func(ctx context.Context, name string, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX)

+ EventsByTimeRange func(ctx context.Context, start, end, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX)

+ type GeneralClient interface

+ FetchConfiguration func(ctx context.Context) (common.ConfigResponse, errors.EdgeX)

+ type IntervalActionClient interface

+ Add func(ctx context.Context, reqs []requests.AddIntervalActionRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllIntervalActions func(ctx context.Context, offset int, limit int) (responses.MultiIntervalActionsResponse, errors.EdgeX)

+ DeleteIntervalActionByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ IntervalActionByName func(ctx context.Context, name string) (responses.IntervalActionResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateIntervalActionRequest) ([]common.BaseResponse, errors.EdgeX)

+ type IntervalClient interface

+ Add func(ctx context.Context, reqs []requests.AddIntervalRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllIntervals func(ctx context.Context, offset int, limit int) (responses.MultiIntervalsResponse, errors.EdgeX)

+ DeleteIntervalByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ IntervalByName func(ctx context.Context, name string) (responses.IntervalResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateIntervalRequest) ([]common.BaseResponse, errors.EdgeX)

+ type NotificationClient interface

+ CleanupNotifications func(ctx context.Context) (common.BaseResponse, errors.EdgeX)

+ CleanupNotificationsByAge func(ctx context.Context, age int) (common.BaseResponse, errors.EdgeX)

+ DeleteNotificationById func(ctx context.Context, id string) (common.BaseResponse, errors.EdgeX)

+ DeleteProcessedNotificationsByAge func(ctx context.Context, age int) (common.BaseResponse, errors.EdgeX)

+ NotificationById func(ctx context.Context, id string) (responses.NotificationResponse, errors.EdgeX)

+ NotificationsByCategory func(ctx context.Context, category string, offset int, limit int) (responses.MultiNotificationsResponse, errors.EdgeX)

+ NotificationsByLabel func(ctx context.Context, label string, offset int, limit int) (responses.MultiNotificationsResponse, errors.EdgeX)

+ NotificationsByStatus func(ctx context.Context, status string, offset int, limit int) (responses.MultiNotificationsResponse, errors.EdgeX)

+ NotificationsBySubscriptionName func(ctx context.Context, subscriptionName string, offset int, limit int) (responses.MultiNotificationsResponse, errors.EdgeX)

+ NotificationsByTimeRange func(ctx context.Context, start int, end int, offset int, limit int) (responses.MultiNotificationsResponse, errors.EdgeX)

+ SendNotification func(ctx context.Context, reqs []requests.AddNotificationRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ type ProvisionWatcherClient interface

+ Add func(ctx context.Context, reqs []requests.AddProvisionWatcherRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllProvisionWatchers func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiProvisionWatchersResponse, errors.EdgeX)

+ DeleteProvisionWatcherByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ ProvisionWatcherByName func(ctx context.Context, name string) (responses.ProvisionWatcherResponse, errors.EdgeX)

+ ProvisionWatchersByProfileName func(ctx context.Context, name string, offset int, limit int) (responses.MultiProvisionWatchersResponse, errors.EdgeX)

+ ProvisionWatchersByServiceName func(ctx context.Context, name string, offset int, limit int) (responses.MultiProvisionWatchersResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateProvisionWatcherRequest) ([]common.BaseResponse, errors.EdgeX)

+ type ReadingClient interface

+ AllReadings func(ctx context.Context, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingCount func(ctx context.Context) (common.CountResponse, errors.EdgeX)

+ ReadingCountByDeviceName func(ctx context.Context, name string) (common.CountResponse, errors.EdgeX)

+ ReadingsByDeviceName func(ctx context.Context, name string, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByDeviceNameAndResourceName func(ctx context.Context, deviceName, resourceName string, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByDeviceNameAndResourceNameAndTimeRange func(ctx context.Context, deviceName, resourceName string, ...) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByDeviceNameAndResourceNamesAndTimeRange func(ctx context.Context, deviceName string, resourceNames []string, ...) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByResourceName func(ctx context.Context, name string, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByResourceNameAndTimeRange func(ctx context.Context, name string, start, end, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ ReadingsByTimeRange func(ctx context.Context, start, end, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX)

+ type SubscriptionClient interface

+ Add func(ctx context.Context, reqs []requests.AddSubscriptionRequest) ([]common.BaseWithIdResponse, errors.EdgeX)

+ AllSubscriptions func(ctx context.Context, offset int, limit int) (responses.MultiSubscriptionsResponse, errors.EdgeX)

+ DeleteSubscriptionByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX)

+ SubscriptionByName func(ctx context.Context, name string) (responses.SubscriptionResponse, errors.EdgeX)

+ SubscriptionsByCategory func(ctx context.Context, category string, offset int, limit int) (responses.MultiSubscriptionsResponse, errors.EdgeX)

+ SubscriptionsByLabel func(ctx context.Context, label string, offset int, limit int) (responses.MultiSubscriptionsResponse, errors.EdgeX)

+ SubscriptionsByReceiver func(ctx context.Context, receiver string, offset int, limit int) (responses.MultiSubscriptionsResponse, errors.EdgeX)

+ Update func(ctx context.Context, reqs []requests.UpdateSubscriptionRequest) ([]common.BaseResponse, errors.EdgeX)

+ type TransmissionClient interface

+ AllTransmissions func(ctx context.Context, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)

+ DeleteProcessedTransmissionsByAge func(ctx context.Context, age int) (common.BaseResponse, errors.EdgeX)

+ TransmissionById func(ctx context.Context, id string) (responses.TransmissionResponse, errors.EdgeX)

+ TransmissionsByNotificationId func(ctx context.Context, id string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)

+ TransmissionsByStatus func(ctx context.Context, status string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)

+ TransmissionsBySubscriptionName func(ctx context.Context, subscriptionName string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)

+ TransmissionsByTimeRange func(ctx context.Context, start int, end int, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)