Versions in this module Expand all Collapse all v4 v4.0.1 Mar 30, 2025 Changes in this version + func NewAuthClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.AuthClient + func NewAuthClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.AuthClient + func NewCommandClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.CommandClient + func NewCommandClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.CommandClient + func NewCommonClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.CommonClient + func NewDeviceClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceClient + func NewDeviceClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.DeviceClient + func NewDeviceProfileClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceProfileClient + func NewDeviceProfileClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.DeviceProfileClient + func NewDeviceServiceClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceServiceClient + func NewDeviceServiceClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.DeviceServiceClient + func NewDeviceServiceCommandClient(authInjector interfaces.AuthenticationInjector, enableNameFieldEscape bool) interfaces.DeviceServiceCommandClient + func NewEventClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.EventClient + func NewEventClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.EventClient + func NewGeneralClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.GeneralClient + func NewKVSClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.KVSClient + func NewNotificationClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.NotificationClient + func NewNotificationClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.NotificationClient + func NewProvisionWatcherClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ProvisionWatcherClient + func NewProvisionWatcherClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.ProvisionWatcherClient + func NewReadingClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ReadingClient + func NewReadingClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.ReadingClient + func NewRegistryClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.RegistryClient + func NewScheduleActionRecordClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ScheduleActionRecordClient + func NewScheduleActionRecordClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.ScheduleActionRecordClient + func NewScheduleJobClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ScheduleJobClient + func NewScheduleJobClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.ScheduleJobClient + func NewSecretStoreTokenClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.SecretStoreTokenClient + func NewSecretStoreTokenClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.AuthClient + func NewSubscriptionClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.SubscriptionClient + func NewSubscriptionClientWithUrlCallback(baseUrlFunc clients.ClientBaseUrlFunc, ...) interfaces.SubscriptionClient + func NewTransmissionClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.TransmissionClient + type AuthClient struct + func (ac *AuthClient) AddKey(ctx context.Context, req requests.AddKeyDataRequest) (dtoCommon.BaseResponse, errors.EdgeX) + func (ac *AuthClient) VerificationKeyByIssuer(ctx context.Context, issuer string) (res responses.KeyDataResponse, err errors.EdgeX) + type CommandClient struct + 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 bool, ...) (res *responses.EventResponse, err errors.EdgeX) + func (client *CommandClient) IssueGetCommandByNameWithQueryParams(ctx context.Context, deviceName string, commandName string, ...) (res *responses.EventResponse, err errors.EdgeX) + func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, ...) (res dtoCommon.BaseResponse, err errors.EdgeX) + type DeviceClient struct + func (dc DeviceClient) Add(ctx context.Context, reqs []requests.AddDeviceRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX) + func (dc DeviceClient) AddWithQueryParams(ctx context.Context, reqs []requests.AddDeviceRequest, ...) (res []dtoCommon.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) AllDevicesWithChildren(ctx context.Context, parent string, maxLevels uint, labels []string, ...) (res responses.MultiDevicesResponse, err errors.EdgeX) + func (dc DeviceClient) DeleteDeviceByName(ctx context.Context, name string) (res dtoCommon.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 dtoCommon.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 []dtoCommon.BaseResponse, err errors.EdgeX) + func (dc DeviceClient) UpdateWithQueryParams(ctx context.Context, reqs []requests.UpdateDeviceRequest, ...) (res []dtoCommon.BaseResponse, err errors.EdgeX) + type DeviceProfileClient struct + func (client *DeviceProfileClient) Add(ctx context.Context, reqs []requests.DeviceProfileRequest) ([]dtoCommon.BaseWithIdResponse, errors.EdgeX) + func (client *DeviceProfileClient) AddByYaml(ctx context.Context, yamlFilePath string) (dtoCommon.BaseWithIdResponse, errors.EdgeX) + func (client *DeviceProfileClient) AddDeviceProfileDeviceCommand(ctx context.Context, reqs []requests.AddDeviceCommandRequest) ([]dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) AddDeviceProfileResource(ctx context.Context, reqs []requests.AddDeviceResourceRequest) ([]dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) AllDeviceProfileBasicInfos(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiDeviceProfileBasicInfoResponse, edgexError 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) (dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) DeleteDeviceCommandByName(ctx context.Context, profileName string, commandName string) (dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) DeleteDeviceResourceByName(ctx context.Context, profileName string, resourceName string) (dtoCommon.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) ([]dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) UpdateByYaml(ctx context.Context, yamlFilePath string) (dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) UpdateDeviceProfileBasicInfo(ctx context.Context, reqs []requests.DeviceProfileBasicInfoRequest) ([]dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) UpdateDeviceProfileDeviceCommand(ctx context.Context, reqs []requests.UpdateDeviceCommandRequest) ([]dtoCommon.BaseResponse, errors.EdgeX) + func (client *DeviceProfileClient) UpdateDeviceProfileResource(ctx context.Context, reqs []requests.UpdateDeviceResourceRequest) ([]dtoCommon.BaseResponse, errors.EdgeX) + type DeviceServiceClient struct + func (dsc DeviceServiceClient) Add(ctx context.Context, reqs []requests.AddDeviceServiceRequest) (res []dtoCommon.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 dtoCommon.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 []dtoCommon.BaseResponse, err errors.EdgeX) + type KVSClient struct + func (kc KVSClient) DeleteKey(ctx context.Context, key string) (res responses.KeysResponse, err errors.EdgeX) + func (kc KVSClient) DeleteKeysByPrefix(ctx context.Context, key string) (res responses.KeysResponse, err errors.EdgeX) + func (kc KVSClient) ListKeys(ctx context.Context, key string) (res responses.KeysResponse, err errors.EdgeX) + func (kc KVSClient) UpdateValuesByKey(ctx context.Context, key string, flatten bool, req requests.UpdateKeysRequest) (res responses.KeysResponse, err errors.EdgeX) + func (kc KVSClient) ValuesByKey(ctx context.Context, key string) (res responses.MultiKeyValueResponse, err errors.EdgeX) + type NotificationClient struct + func (client *NotificationClient) CleanupNotifications(ctx context.Context) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *NotificationClient) CleanupNotificationsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *NotificationClient) DeleteNotificationById(ctx context.Context, id string) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *NotificationClient) DeleteNotificationByIds(ctx context.Context, ids []string) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *NotificationClient) DeleteProcessedNotificationsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationById(ctx context.Context, id string) (res responses.NotificationResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsByCategory(ctx context.Context, category string, offset int, limit int, ack string) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsByLabel(ctx context.Context, label string, offset int, limit int, ack string) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsByQueryConditions(ctx context.Context, offset, limit int, ack string, ...) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsByStatus(ctx context.Context, status string, offset int, limit int, ack string) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsBySubscriptionName(ctx context.Context, subscriptionName string, offset int, limit int, ...) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) NotificationsByTimeRange(ctx context.Context, start int64, end int64, offset int, limit int, ack string) (res responses.MultiNotificationsResponse, err errors.EdgeX) + func (client *NotificationClient) SendNotification(ctx context.Context, reqs []requests.AddNotificationRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX) + func (client *NotificationClient) UpdateNotificationAckStatusByIds(ctx context.Context, ack bool, ids []string) (res dtoCommon.BaseResponse, err errors.EdgeX) + type ProvisionWatcherClient struct + func (pwc ProvisionWatcherClient) Add(ctx context.Context, reqs []requests.AddProvisionWatcherRequest) (res []dtoCommon.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 dtoCommon.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 []dtoCommon.BaseResponse, err errors.EdgeX) + type ScheduleActionRecordClient struct + func (client *ScheduleActionRecordClient) AllScheduleActionRecords(ctx context.Context, start, end int64, offset, limit int) (res responses.MultiScheduleActionRecordsResponse, err errors.EdgeX) + func (client *ScheduleActionRecordClient) LatestScheduleActionRecordsByJobName(ctx context.Context, jobName string) (res responses.MultiScheduleActionRecordsResponse, err errors.EdgeX) + func (client *ScheduleActionRecordClient) ScheduleActionRecordsByJobName(ctx context.Context, jobName string, start, end int64, offset, limit int) (res responses.MultiScheduleActionRecordsResponse, err errors.EdgeX) + func (client *ScheduleActionRecordClient) ScheduleActionRecordsByJobNameAndStatus(ctx context.Context, jobName, status string, start, end int64, ...) (res responses.MultiScheduleActionRecordsResponse, err errors.EdgeX) + func (client *ScheduleActionRecordClient) ScheduleActionRecordsByStatus(ctx context.Context, status string, start, end int64, offset, limit int) (res responses.MultiScheduleActionRecordsResponse, err errors.EdgeX) + type ScheduleJobClient struct + func (client ScheduleJobClient) Add(ctx context.Context, reqs []requests.AddScheduleJobRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX) + func (client ScheduleJobClient) AllScheduleJobs(ctx context.Context, labels []string, offset, limit int) (res responses.MultiScheduleJobsResponse, err errors.EdgeX) + func (client ScheduleJobClient) DeleteScheduleJobByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client ScheduleJobClient) ScheduleJobByName(ctx context.Context, name string) (res responses.ScheduleJobResponse, err errors.EdgeX) + func (client ScheduleJobClient) TriggerScheduleJobByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client ScheduleJobClient) Update(ctx context.Context, reqs []requests.UpdateScheduleJobRequest) (res []dtoCommon.BaseResponse, err errors.EdgeX) + type SecretStoreTokenClient struct + func (ac *SecretStoreTokenClient) RegenToken(ctx context.Context, entityId string) (dtoCommon.BaseResponse, errors.EdgeX) + type SubscriptionClient struct + func (client *SubscriptionClient) Add(ctx context.Context, reqs []requests.AddSubscriptionRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX) + func (client *SubscriptionClient) AllSubscriptions(ctx context.Context, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX) + func (client *SubscriptionClient) DeleteSubscriptionByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *SubscriptionClient) SubscriptionByName(ctx context.Context, name string) (res responses.SubscriptionResponse, err errors.EdgeX) + func (client *SubscriptionClient) SubscriptionsByCategory(ctx context.Context, category string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX) + func (client *SubscriptionClient) SubscriptionsByLabel(ctx context.Context, label string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX) + func (client *SubscriptionClient) SubscriptionsByReceiver(ctx context.Context, receiver string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX) + func (client *SubscriptionClient) Update(ctx context.Context, reqs []requests.UpdateSubscriptionRequest) (res []dtoCommon.BaseResponse, err errors.EdgeX) + type TransmissionClient struct + func (client *TransmissionClient) AllTransmissions(ctx context.Context, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX) + func (client *TransmissionClient) DeleteProcessedTransmissionsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX) + func (client *TransmissionClient) TransmissionById(ctx context.Context, id string) (res responses.TransmissionResponse, err errors.EdgeX) + func (client *TransmissionClient) TransmissionsByNotificationId(ctx context.Context, id string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX) + func (client *TransmissionClient) TransmissionsByStatus(ctx context.Context, status string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX) + func (client *TransmissionClient) TransmissionsBySubscriptionName(ctx context.Context, subscriptionName string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX) + func (client *TransmissionClient) TransmissionsByTimeRange(ctx context.Context, start int64, end int64, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX) Other modules containing this package github.com/agile-edge/go-mod-core-contracts/v3
Go to main page