Versions in this module Expand all Collapse all v4 v4.0.0 Nov 21, 2024 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) + AddWithQueryParams 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) + AllDevicesWithChildren func(ctx context.Context, parent string, maxLevels uint, labels []string, ...) (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) + UpdateWithQueryParams 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) + AllDeviceProfileBasicInfos func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiDeviceProfileBasicInfoResponse, 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 + Discovery func(ctx context.Context, baseUrl string) (common.BaseResponse, errors.EdgeX) + GetCommand func(ctx context.Context, baseUrl string, deviceName string, commandName string, ...) (*responses.EventResponse, errors.EdgeX) + ProfileScan func(ctx context.Context, baseUrl string, req requests.ProfileScanRequest) (common.BaseResponse, 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) + StopDeviceDiscovery func(ctx context.Context, baseUrl string, requestId string, ...) (common.BaseResponse, errors.EdgeX) + StopProfileScan func(ctx context.Context, baseUrl string, deviceName 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) + DeleteById func(ctx context.Context, id 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 int64, offset, limit int) (responses.MultiEventsResponse, errors.EdgeX) + type GeneralClient interface + FetchConfiguration func(ctx context.Context) (common.ConfigResponse, errors.EdgeX) + type KVSClient interface + DeleteKey func(ctx context.Context, key string) (responses.KeysResponse, errors.EdgeX) + DeleteKeysByPrefix func(ctx context.Context, key string) (responses.KeysResponse, errors.EdgeX) + ListKeys func(ctx context.Context, key string) (responses.KeysResponse, errors.EdgeX) + UpdateValuesByKey func(ctx context.Context, key string, flatten bool, reqs requests.UpdateKeysRequest) (responses.KeysResponse, errors.EdgeX) + ValuesByKey func(ctx context.Context, key string) (responses.MultiKeyValueResponse, 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) + DeleteNotificationByIds func(ctx context.Context, ids []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, ack string) (responses.MultiNotificationsResponse, errors.EdgeX) + NotificationsByLabel func(ctx context.Context, label string, offset int, limit int, ack string) (responses.MultiNotificationsResponse, errors.EdgeX) + NotificationsByQueryConditions func(ctx context.Context, offset, limit int, ack string, ...) (responses.MultiNotificationsResponse, errors.EdgeX) + NotificationsByStatus func(ctx context.Context, status string, offset int, limit int, ack string) (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, end int64, offset int, limit int, ack string) (responses.MultiNotificationsResponse, errors.EdgeX) + SendNotification func(ctx context.Context, reqs []requests.AddNotificationRequest) ([]common.BaseWithIdResponse, errors.EdgeX) + UpdateNotificationAckStatusByIds func(ctx context.Context, ack bool, ids []string) (common.BaseResponse, 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, start, end int64, ...) (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 int64, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX) + ReadingsByTimeRange func(ctx context.Context, start, end int64, offset, limit int) (responses.MultiReadingsResponse, errors.EdgeX) + type RegistryClient interface + AllRegistry func(context.Context, bool) (responses.MultiRegistrationsResponse, errors.EdgeX) + Deregister func(context.Context, string) errors.EdgeX + Register func(context.Context, requests.AddRegistrationRequest) errors.EdgeX + RegistrationByServiceId func(context.Context, string) (responses.RegistrationResponse, errors.EdgeX) + UpdateRegister func(context.Context, requests.AddRegistrationRequest) errors.EdgeX + type ScheduleActionRecordClient interface + AllScheduleActionRecords func(ctx context.Context, start, end int64, offset, limit int) (responses.MultiScheduleActionRecordsResponse, errors.EdgeX) + LatestScheduleActionRecordsByJobName func(ctx context.Context, jobName string) (responses.MultiScheduleActionRecordsResponse, errors.EdgeX) + ScheduleActionRecordsByJobName func(ctx context.Context, jobName string, start, end int64, offset, limit int) (responses.MultiScheduleActionRecordsResponse, errors.EdgeX) + ScheduleActionRecordsByJobNameAndStatus func(ctx context.Context, jobName, status string, start, end int64, ...) (responses.MultiScheduleActionRecordsResponse, errors.EdgeX) + ScheduleActionRecordsByStatus func(ctx context.Context, status string, start, end int64, offset, limit int) (responses.MultiScheduleActionRecordsResponse, errors.EdgeX) + type ScheduleJobClient interface + Add func(ctx context.Context, reqs []requests.AddScheduleJobRequest) ([]common.BaseWithIdResponse, errors.EdgeX) + AllScheduleJobs func(ctx context.Context, labels []string, offset int, limit int) (responses.MultiScheduleJobsResponse, errors.EdgeX) + DeleteScheduleJobByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX) + ScheduleJobByName func(ctx context.Context, name string) (responses.ScheduleJobResponse, errors.EdgeX) + TriggerScheduleJobByName func(ctx context.Context, name string) (common.BaseResponse, errors.EdgeX) + Update func(ctx context.Context, reqs []requests.UpdateScheduleJobRequest) ([]common.BaseResponse, errors.EdgeX) + type SecureTransportProvider interface + RoundTripper func() http.RoundTripper + 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, end int64, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX) v4.0.0-1 Dec 19, 2024 Other modules containing this package git.buildlinx.io/buildlinx/edgelinx/go-libs/go-mod-core-contracts/v3
Go to main page