Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

http

package

Go to main page

Versions in this module

v1

v1.0.2

Aug 29, 2024

v1.0.1

Jul 30, 2024

Changes in this version

+ func NewApplicationClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.ApplicationClient

+ func NewCommandClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.CommandClient

+ func NewCommonClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.CommonClient

+ func NewDeviceClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceClient

+ func NewDeviceHistoryClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.DeviceHistoryClient

+ func NewDeviceProfileClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceProfileClient

+ func NewDeviceServiceCallbackClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceServiceCallbackClient

+ func NewDeviceServiceClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.DeviceServiceClient

+ func NewDeviceServiceCommandClient(authInjector interfaces.AuthenticationInjector, enableNameFieldEscape bool) interfaces.DeviceServiceCommandClient

+ func NewEventClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.EventClient

+ func NewGeneralClient(baseUrl string, authInjector interfaces.AuthenticationInjector) interfaces.GeneralClient

+ func NewIntervalActionClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.IntervalActionClient

+ func NewIntervalClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.IntervalClient

+ func NewNotificationClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.NotificationClient

+ func NewProvisionWatcherClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ProvisionWatcherClient

+ func NewReadingClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.ReadingClient

+ func NewSubscriptionClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.SubscriptionClient

+ func NewTransmissionClient(baseUrl string, authInjector interfaces.AuthenticationInjector, ...) interfaces.TransmissionClient

+ type ApplicationClient struct

+ func (dc ApplicationClient) AllApplications(ctx context.Context, labels []string, offset int, limit int) (res responses.MultiApplicationsResponse, 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)

+ func (client *CommandClient) IssueSetCommandByNameWithObject(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) 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 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) DevicesByParentDeviceName(ctx context.Context, name string, offset int, limit int) (res responses.MultiLinksResponse, 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) LogicalDeleteDeviceByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX)

+ func (dc DeviceClient) LogicalRestoreDeviceByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX)

+ func (dc DeviceClient) Update(ctx context.Context, reqs []requests.UpdateDeviceRequest) (res []dtoCommon.BaseResponse, err errors.EdgeX)

+ type DeviceHistoryClient struct

+ func (dc DeviceHistoryClient) Add(ctx context.Context, reqs []requests.AddDeviceHistoryRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX)

+ func (dc DeviceHistoryClient) DevicesHistoryByName(ctx context.Context, name string) (res responses.MultiDevicesHistoryResponse, 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) 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) GetDeviceProfilesManufacturerList(ctx context.Context) (res responses.DeviceProfileListResponse, edgexError errors.EdgeX)

+ func (client *DeviceProfileClient) GetDeviceProfilesModelList(ctx context.Context) (res responses.DeviceProfileListResponse, edgexError errors.EdgeX)

+ func (client *DeviceProfileClient) GetDeviceProfilesNameList(ctx context.Context) (res responses.DeviceProfileListResponse, 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 IntervalActionClient struct

+ func (client IntervalActionClient) Add(ctx context.Context, reqs []requests.AddIntervalActionRequest) (res []dtoCommon.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 dtoCommon.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 []dtoCommon.BaseResponse, err errors.EdgeX)

+ type IntervalClient struct

+ func (client IntervalClient) Add(ctx context.Context, reqs []requests.AddIntervalRequest) (res []dtoCommon.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 dtoCommon.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 []dtoCommon.BaseResponse, 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) 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) (res responses.MultiNotificationsResponse, err errors.EdgeX)

+ func (client *NotificationClient) NotificationsByLabel(ctx context.Context, label string, offset int, limit int) (res responses.MultiNotificationsResponse, err errors.EdgeX)

+ func (client *NotificationClient) NotificationsByStatus(ctx context.Context, status string, offset int, limit int) (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 int, end int, offset int, limit int) (res responses.MultiNotificationsResponse, err errors.EdgeX)

+ func (client *NotificationClient) SendNotification(ctx context.Context, reqs []requests.AddNotificationRequest) (res []dtoCommon.BaseWithIdResponse, 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 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 int, end int, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

v1.0.0-2.3.0

Nov 25, 2024

JackTT - Gopher 🇻🇳