http

package
v3.0.0-dev.27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 9, 2023 License: Apache-2.0 Imports: 16 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCommandClient

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

NewCommandClient creates an instance of CommandClient

func NewCommonClient

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

NewCommonClient creates an instance of CommonClient

func NewDeviceClient

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

NewDeviceClient creates an instance of DeviceClient

func NewDeviceProfileClient

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

NewDeviceProfileClient creates an instance of DeviceProfileClient

func NewDeviceServiceCallbackClient

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

NewDeviceServiceCallbackClient creates an instance of deviceServiceCallbackClient

func NewDeviceServiceClient

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

NewDeviceServiceClient creates an instance of DeviceServiceClient

func NewDeviceServiceCommandClient

func NewDeviceServiceCommandClient(authInjector interfaces.AuthenticationInjector) interfaces.DeviceServiceCommandClient

NewDeviceServiceCommandClient creates an instance of deviceServiceCommandClient

func NewEventClient

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

NewEventClient creates an instance of EventClient

func NewGeneralClient

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

func NewIntervalActionClient

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

NewIntervalActionClient creates an instance of IntervalActionClient

func NewIntervalClient

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

NewIntervalClient creates an instance of IntervalClient

func NewNotificationClient

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

NewNotificationClient creates an instance of NotificationClient

func NewProvisionWatcherClient

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

NewProvisionWatcherClient creates an instance of ProvisionWatcherClient

func NewReadingClient

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

NewReadingClient creates an instance of ReadingClient

func NewSubscriptionClient

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

NewSubscriptionClient creates an instance of SubscriptionClient

func NewTransmissionClient

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

NewTransmissionClient creates an instance of TransmissionClient

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 bool, dsReturnEvent bool) (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) IssueGetCommandByNameWithQueryParams

func (client *CommandClient) IssueGetCommandByNameWithQueryParams(ctx context.Context, deviceName string, commandName string, queryParams map[string]string) (res *responses.EventResponse, err errors.EdgeX)

func (*CommandClient) IssueSetCommandByName

func (client *CommandClient) IssueSetCommandByName(ctx context.Context, deviceName string, commandName string, settings map[string]string) (res dtoCommon.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.

func (*CommandClient) IssueSetCommandByNameWithObject

func (client *CommandClient) IssueSetCommandByNameWithObject(ctx context.Context, deviceName string, commandName string, settings map[string]interface{}) (res dtoCommon.BaseResponse, err errors.EdgeX)

IssueSetCommandByNameWithObject issues the specified write command and the settings supports object value type

type DeviceClient

type DeviceClient struct {
	// contains filtered or unexported fields
}

func (DeviceClient) Add

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 dtoCommon.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 dtoCommon.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

type DeviceProfileClient

type DeviceProfileClient struct {
	// contains filtered or unexported fields
}

func (*DeviceProfileClient) Add

Add adds new device profile

func (*DeviceProfileClient) AddByYaml

func (client *DeviceProfileClient) AddByYaml(ctx context.Context, yamlFilePath string) (dtoCommon.BaseWithIdResponse, errors.EdgeX)

AddByYaml adds new device profile by uploading a yaml file

func (*DeviceProfileClient) AddDeviceProfileDeviceCommand

func (client *DeviceProfileClient) AddDeviceProfileDeviceCommand(ctx context.Context, reqs []requests.AddDeviceCommandRequest) ([]dtoCommon.BaseResponse, errors.EdgeX)

AddDeviceProfileDeviceCommand adds new device command to an existing profile

func (*DeviceProfileClient) AddDeviceProfileResource

func (client *DeviceProfileClient) AddDeviceProfileResource(ctx context.Context, reqs []requests.AddDeviceResourceRequest) ([]dtoCommon.BaseResponse, errors.EdgeX)

AddDeviceProfileResource adds new device resource to an existing profile

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) (dtoCommon.BaseResponse, errors.EdgeX)

DeleteByName deletes the device profile by name

func (*DeviceProfileClient) DeleteDeviceCommandByName

func (client *DeviceProfileClient) DeleteDeviceCommandByName(ctx context.Context, profileName string, commandName string) (dtoCommon.BaseResponse, errors.EdgeX)

DeleteDeviceCommandByName deletes device command by name

func (*DeviceProfileClient) DeleteDeviceResourceByName

func (client *DeviceProfileClient) DeleteDeviceResourceByName(ctx context.Context, profileName string, resourceName string) (dtoCommon.BaseResponse, errors.EdgeX)

DeleteDeviceResourceByName deletes device resource 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

Update updates device profile

func (*DeviceProfileClient) UpdateByYaml

func (client *DeviceProfileClient) UpdateByYaml(ctx context.Context, yamlFilePath string) (dtoCommon.BaseResponse, errors.EdgeX)

UpdateByYaml updates device profile by uploading a yaml file

func (*DeviceProfileClient) UpdateDeviceProfileBasicInfo

func (client *DeviceProfileClient) UpdateDeviceProfileBasicInfo(ctx context.Context, reqs []requests.DeviceProfileBasicInfoRequest) ([]dtoCommon.BaseResponse, errors.EdgeX)

UpdateDeviceProfileBasicInfo updates existing profile's basic info

func (*DeviceProfileClient) UpdateDeviceProfileDeviceCommand

func (client *DeviceProfileClient) UpdateDeviceProfileDeviceCommand(ctx context.Context, reqs []requests.UpdateDeviceCommandRequest) ([]dtoCommon.BaseResponse, errors.EdgeX)

UpdateDeviceProfileDeviceCommand updates existing device command

func (*DeviceProfileClient) UpdateDeviceProfileResource

func (client *DeviceProfileClient) UpdateDeviceProfileResource(ctx context.Context, reqs []requests.UpdateDeviceResourceRequest) ([]dtoCommon.BaseResponse, errors.EdgeX)

UpdateDeviceProfileResource updates existing device resource

type DeviceServiceClient

type DeviceServiceClient struct {
	// contains filtered or unexported fields
}

func (DeviceServiceClient) Add

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 dtoCommon.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

type IntervalActionClient

type IntervalActionClient struct {
	// contains filtered or unexported fields
}

func (IntervalActionClient) Add

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 dtoCommon.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

Update updates intervalActions

type IntervalClient

type IntervalClient struct {
	// contains filtered or unexported fields
}

func (IntervalClient) Add

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 dtoCommon.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

Update updates intervals

type NotificationClient

type NotificationClient struct {
	// contains filtered or unexported fields
}

func (*NotificationClient) CleanupNotifications

func (client *NotificationClient) CleanupNotifications(ctx context.Context) (res dtoCommon.BaseResponse, err errors.EdgeX)

CleanupNotifications removes notifications and the corresponding transmissions.

func (*NotificationClient) CleanupNotificationsByAge

func (client *NotificationClient) CleanupNotificationsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX)

CleanupNotificationsByAge removes notifications that are older than age. And the corresponding transmissions will also be deleted. Age is supposed in milliseconds since modified timestamp

func (*NotificationClient) DeleteNotificationById

func (client *NotificationClient) DeleteNotificationById(ctx context.Context, id string) (res dtoCommon.BaseResponse, err errors.EdgeX)

DeleteNotificationById deletes a notification by id.

func (*NotificationClient) DeleteProcessedNotificationsByAge

func (client *NotificationClient) DeleteProcessedNotificationsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX)

DeleteProcessedNotificationsByAge removes processed notifications that are older than age. And the corresponding transmissions will also be deleted. Age is supposed in milliseconds since modified timestamp Please notice that this API is only for processed notifications (status = PROCESSED). If the deletion purpose includes each kind of notifications, please refer to cleanup API.

func (*NotificationClient) NotificationById

func (client *NotificationClient) NotificationById(ctx context.Context, id string) (res responses.NotificationResponse, err errors.EdgeX)

NotificationById query notification by id.

func (*NotificationClient) NotificationsByCategory

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

NotificationsByCategory queries notifications with category, offset and limit

func (*NotificationClient) NotificationsByLabel

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

NotificationsByLabel queries notifications with label, offset and limit

func (*NotificationClient) NotificationsByStatus

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

NotificationsByStatus queries notifications with status, offset and limit

func (*NotificationClient) NotificationsBySubscriptionName

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

NotificationsBySubscriptionName query notifications with subscriptionName, offset and limit

func (*NotificationClient) NotificationsByTimeRange

func (client *NotificationClient) NotificationsByTimeRange(ctx context.Context, start int, end int, offset int, limit int) (res responses.MultiNotificationsResponse, err errors.EdgeX)

NotificationsByTimeRange query notifications with time range, offset and limit

func (*NotificationClient) SendNotification

func (client *NotificationClient) SendNotification(ctx context.Context, reqs []requests.AddNotificationRequest) (res []dtoCommon.BaseWithIdResponse, err errors.EdgeX)

SendNotification sends new notifications.

type ProvisionWatcherClient

type ProvisionWatcherClient struct {
	// contains filtered or unexported fields
}

func (ProvisionWatcherClient) Add

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 dtoCommon.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

type SubscriptionClient

type SubscriptionClient struct {
	// contains filtered or unexported fields
}

func (*SubscriptionClient) Add

Add adds new subscriptions.

func (*SubscriptionClient) AllSubscriptions

func (client *SubscriptionClient) AllSubscriptions(ctx context.Context, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX)

AllSubscriptions queries subscriptions with offset and limit

func (*SubscriptionClient) DeleteSubscriptionByName

func (client *SubscriptionClient) DeleteSubscriptionByName(ctx context.Context, name string) (res dtoCommon.BaseResponse, err errors.EdgeX)

DeleteSubscriptionByName deletes a subscription by name.

func (*SubscriptionClient) SubscriptionByName

func (client *SubscriptionClient) SubscriptionByName(ctx context.Context, name string) (res responses.SubscriptionResponse, err errors.EdgeX)

SubscriptionByName query subscription by name.

func (*SubscriptionClient) SubscriptionsByCategory

func (client *SubscriptionClient) SubscriptionsByCategory(ctx context.Context, category string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX)

SubscriptionsByCategory queries subscriptions with category, offset and limit

func (*SubscriptionClient) SubscriptionsByLabel

func (client *SubscriptionClient) SubscriptionsByLabel(ctx context.Context, label string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX)

SubscriptionsByLabel queries subscriptions with label, offset and limit

func (*SubscriptionClient) SubscriptionsByReceiver

func (client *SubscriptionClient) SubscriptionsByReceiver(ctx context.Context, receiver string, offset int, limit int) (res responses.MultiSubscriptionsResponse, err errors.EdgeX)

SubscriptionsByReceiver queries subscriptions with receiver, offset and limit

func (*SubscriptionClient) Update

Update updates subscriptions.

type TransmissionClient

type TransmissionClient struct {
	// contains filtered or unexported fields
}

func (*TransmissionClient) AllTransmissions

func (client *TransmissionClient) AllTransmissions(ctx context.Context, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

AllTransmissions query transmissions with offset and limit

func (*TransmissionClient) DeleteProcessedTransmissionsByAge

func (client *TransmissionClient) DeleteProcessedTransmissionsByAge(ctx context.Context, age int) (res dtoCommon.BaseResponse, err errors.EdgeX)

DeleteProcessedTransmissionsByAge deletes the processed transmissions if the current timestamp minus their created timestamp is less than the age parameter.

func (*TransmissionClient) TransmissionById

func (client *TransmissionClient) TransmissionById(ctx context.Context, id string) (res responses.TransmissionResponse, err errors.EdgeX)

TransmissionById query transmission by id.

func (*TransmissionClient) TransmissionsByNotificationId

func (client *TransmissionClient) TransmissionsByNotificationId(ctx context.Context, id string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

TransmissionsByNotificationId query transmissions with notification id, offset and limit

func (*TransmissionClient) TransmissionsByStatus

func (client *TransmissionClient) TransmissionsByStatus(ctx context.Context, status string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

TransmissionsByStatus queries transmissions with status, offset and limit

func (*TransmissionClient) TransmissionsBySubscriptionName

func (client *TransmissionClient) TransmissionsBySubscriptionName(ctx context.Context, subscriptionName string, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

TransmissionsBySubscriptionName query transmissions with subscriptionName, offset and limit

func (*TransmissionClient) TransmissionsByTimeRange

func (client *TransmissionClient) TransmissionsByTimeRange(ctx context.Context, start int, end int, offset int, limit int) (res responses.MultiTransmissionsResponse, err errors.EdgeX)

TransmissionsByTimeRange query transmissions with time range, offset and limit

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL