requests

package
v3.2.0-dev.30 Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2024 License: Apache-2.0 Imports: 10 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddDeviceReqToDeviceModels 

func AddDeviceReqToDeviceModels(addRequests []AddDeviceRequest) (Devices []models.Device)

AddDeviceReqToDeviceModels transforms the AddDeviceRequest DTO array to the Device model array

func AddDeviceServiceReqToDeviceServiceModels 

func AddDeviceServiceReqToDeviceServiceModels(addRequests []AddDeviceServiceRequest) (DeviceServices []models.DeviceService)

AddDeviceServiceReqToDeviceServiceModels transforms the AddDeviceServiceRequest DTO array to the DeviceService model array

func AddEventReqToEventModel 

func AddEventReqToEventModel(addEventReq AddEventRequest) (event models.Event)

AddEventReqToEventModel transforms the AddEventRequest DTO to the Event model

func AddIntervalActionReqToIntervalActionModels 

func AddIntervalActionReqToIntervalActionModels(addRequests []AddIntervalActionRequest) (actions []models.IntervalAction)

AddIntervalActionReqToIntervalActionModels transforms the AddIntervalActionRequest DTO array to the IntervalAction model array

func AddIntervalReqToIntervalModels 

func AddIntervalReqToIntervalModels(addRequests []AddIntervalRequest) (intervals []models.Interval)

AddIntervalReqToIntervalModels transforms the AddIntervalRequest DTO array to the Interval model array

func AddNotificationReqToNotificationModels 

func AddNotificationReqToNotificationModels(reqs []AddNotificationRequest) (n []models.Notification)

AddNotificationReqToNotificationModels transforms the AddNotificationRequest DTO array to the AddNotificationRequest model array

func AddProvisionWatcherReqToProvisionWatcherModels 

func AddProvisionWatcherReqToProvisionWatcherModels(addRequests []AddProvisionWatcherRequest) (ProvisionWatchers []models.ProvisionWatcher)

AddProvisionWatcherReqToProvisionWatcherModels transforms the AddProvisionWatcherRequest DTO array to the ProvisionWatcher model array

func AddSubscriptionReqToSubscriptionModels 

func AddSubscriptionReqToSubscriptionModels(reqs []AddSubscriptionRequest) (s []models.Subscription)

AddSubscriptionReqToSubscriptionModels transforms the AddSubscriptionRequest DTO array to the AddSubscriptionRequest model array

func DeviceProfileReqToDeviceProfileModel 

func DeviceProfileReqToDeviceProfileModel(addReq DeviceProfileRequest) (DeviceProfiles models.DeviceProfile)

DeviceProfileReqToDeviceProfileModel transforms the DeviceProfileRequest DTO to the DeviceProfile model

func DeviceProfileReqToDeviceProfileModels 

func DeviceProfileReqToDeviceProfileModels(addRequests []DeviceProfileRequest) (DeviceProfiles []models.DeviceProfile)

DeviceProfileReqToDeviceProfileModels transforms the DeviceProfileRequest DTO array to the DeviceProfile model array

func ReplaceDeviceCommandModelFieldsWithDTO 

func ReplaceDeviceCommandModelFieldsWithDTO(dc *models.DeviceCommand, patch dtos.UpdateDeviceCommand)

ReplaceDeviceCommandModelFieldsWithDTO replace existing DeviceCommand's fields with DTO patch

func ReplaceDeviceModelFieldsWithDTO 

func ReplaceDeviceModelFieldsWithDTO(device *models.Device, patch dtos.UpdateDevice)

ReplaceDeviceModelFieldsWithDTO replace existing Device's fields with DTO patch

func ReplaceDeviceProfileModelBasicInfoFieldsWithDTO 

func ReplaceDeviceProfileModelBasicInfoFieldsWithDTO(dp *models.DeviceProfile, patch dtos.UpdateDeviceProfileBasicInfo)

ReplaceDeviceProfileModelBasicInfoFieldsWithDTO replace existing DeviceProfile's basic info fields with DTO patch

func ReplaceDeviceResourceModelFieldsWithDTO 

func ReplaceDeviceResourceModelFieldsWithDTO(dr *models.DeviceResource, patch dtos.UpdateDeviceResource)

ReplaceDeviceResourceModelFieldsWithDTO replace existing DeviceResource's fields with DTO patch

func ReplaceDeviceServiceModelFieldsWithDTO 

func ReplaceDeviceServiceModelFieldsWithDTO(ds *models.DeviceService, patch dtos.UpdateDeviceService)

ReplaceDeviceServiceModelFieldsWithDTO replace existing DeviceService's fields with DTO patch

func ReplaceIntervalActionModelFieldsWithDTO 

func ReplaceIntervalActionModelFieldsWithDTO(action *models.IntervalAction, patch dtos.UpdateIntervalAction)

ReplaceIntervalActionModelFieldsWithDTO replace existing IntervalAction's fields with DTO patch

func ReplaceIntervalModelFieldsWithDTO 

func ReplaceIntervalModelFieldsWithDTO(interval *models.Interval, patch dtos.UpdateInterval)

ReplaceIntervalModelFieldsWithDTO replace existing Interval's fields with DTO patch

func ReplaceProvisionWatcherModelFieldsWithDTO 

func ReplaceProvisionWatcherModelFieldsWithDTO(pw *models.ProvisionWatcher, patch dtos.UpdateProvisionWatcher)

ReplaceProvisionWatcherModelFieldsWithDTO replace existing ProvisionWatcher's fields with DTO patch

func ReplaceSubscriptionModelFieldsWithDTO 

func ReplaceSubscriptionModelFieldsWithDTO(s *models.Subscription, patch dtos.UpdateSubscription)

ReplaceSubscriptionModelFieldsWithDTO replace existing Subscription's fields with DTO patch

func UpdateKeysReqToKVModels 

func UpdateKeysReqToKVModels(req UpdateKeysRequest, key string) models.KVS

UpdateKeysReqToKVModels transforms the UpdateKeysRequest DTO to the KV model

Types

type AddDeviceCommandRequest 

type AddDeviceCommandRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProfileName           string             `json:"profileName" validate:"required,edgex-dto-none-empty-string"`
	DeviceCommand         dtos.DeviceCommand `json:"deviceCommand"`
}

AddDeviceCommandRequest defines the Request Content for POST DeviceCommand DTO.

func (*AddDeviceCommandRequest) UnmarshalJSON 

func (dc *AddDeviceCommandRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddDeviceCommandRequest type

func (AddDeviceCommandRequest) Validate 

func (request AddDeviceCommandRequest) Validate() error

Validate satisfies the Validator interface

type AddDeviceRequest 

type AddDeviceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Device                dtos.Device `json:"device"`
}

AddDeviceRequest defines the Request Content for POST Device DTO.

func NewAddDeviceRequest 

func NewAddDeviceRequest(dto dtos.Device) AddDeviceRequest

func (*AddDeviceRequest) UnmarshalJSON 

func (d *AddDeviceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddDeviceRequest type

func (AddDeviceRequest) Validate 

func (d AddDeviceRequest) Validate() error

Validate satisfies the Validator interface

type AddDeviceResourceRequest 

type AddDeviceResourceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProfileName           string              `json:"profileName" validate:"required,edgex-dto-none-empty-string"`
	Resource              dtos.DeviceResource `json:"resource"`
}

AddDeviceResourceRequest defines the Request Content for POST DeviceResource DTO.

func (*AddDeviceResourceRequest) UnmarshalJSON 

func (dr *AddDeviceResourceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddDeviceResourceReques type

func (AddDeviceResourceRequest) Validate 

func (request AddDeviceResourceRequest) Validate() error

type AddDeviceServiceRequest 

type AddDeviceServiceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Service               dtos.DeviceService `json:"service"`
}

AddDeviceServiceRequest defines the Request Content for POST DeviceService DTO.

func NewAddDeviceServiceRequest 

func NewAddDeviceServiceRequest(dto dtos.DeviceService) AddDeviceServiceRequest

func (*AddDeviceServiceRequest) UnmarshalJSON 

func (ds *AddDeviceServiceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddDeviceServiceRequest type

func (AddDeviceServiceRequest) Validate 

func (ds AddDeviceServiceRequest) Validate() error

Validate satisfies the Validator interface

type AddEventRequest 

type AddEventRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Event                 dtos.Event `json:"event" validate:"required"`
}

AddEventRequest defines the Request Content for POST event DTO.

func NewAddEventRequest 

func NewAddEventRequest(event dtos.Event) AddEventRequest

NewAddEventRequest creates, initializes and returns an AddEventRequests

func (*AddEventRequest) Encode 

func (a *AddEventRequest) Encode() ([]byte, string, error)

func (*AddEventRequest) Unmarshal 

func (a *AddEventRequest) Unmarshal(b []byte, f unmarshal) error

func (*AddEventRequest) UnmarshalCBOR 

func (a *AddEventRequest) UnmarshalCBOR(b []byte) error

func (*AddEventRequest) UnmarshalJSON 

func (a *AddEventRequest) UnmarshalJSON(b []byte) error

func (AddEventRequest) Validate 

func (a AddEventRequest) Validate() error

Validate satisfies the Validator interface

type AddIntervalActionRequest 

type AddIntervalActionRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Action                dtos.IntervalAction `json:"action"`
}

AddIntervalActionRequest defines the Request Content for POST Interval DTO.

func NewAddIntervalActionRequest 

func NewAddIntervalActionRequest(dto dtos.IntervalAction) AddIntervalActionRequest

func (*AddIntervalActionRequest) UnmarshalJSON 

func (request *AddIntervalActionRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddIntervalActionRequest type

func (AddIntervalActionRequest) Validate 

func (request AddIntervalActionRequest) Validate() error

Validate satisfies the Validator interface

type AddIntervalRequest 

type AddIntervalRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Interval              dtos.Interval `json:"interval"`
}

AddIntervalRequest defines the Request Content for POST Interval DTO.

func NewAddIntervalRequest 

func NewAddIntervalRequest(dto dtos.Interval) AddIntervalRequest

func (*AddIntervalRequest) UnmarshalJSON 

func (request *AddIntervalRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddIntervalRequest type

func (AddIntervalRequest) Validate 

func (request AddIntervalRequest) Validate() error

Validate satisfies the Validator interface

type AddNotificationRequest 

type AddNotificationRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Notification          dtos.Notification `json:"notification"`
}

AddNotificationRequest defines the Request Content for POST Notification DTO.

func NewAddNotificationRequest 

func NewAddNotificationRequest(dto dtos.Notification) AddNotificationRequest

func (*AddNotificationRequest) UnmarshalJSON 

func (request *AddNotificationRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddNotificationRequest type

func (AddNotificationRequest) Validate 

func (request AddNotificationRequest) Validate() error

Validate satisfies the Validator interface

type AddProvisionWatcherRequest 

type AddProvisionWatcherRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProvisionWatcher      dtos.ProvisionWatcher `json:"provisionWatcher"`
}

AddProvisionWatcherRequest defines the Request Content for POST ProvisionWatcher DTO.

func NewAddProvisionWatcherRequest 

func NewAddProvisionWatcherRequest(dto dtos.ProvisionWatcher) AddProvisionWatcherRequest

func (*AddProvisionWatcherRequest) UnmarshalJSON 

func (pw *AddProvisionWatcherRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddProvisionWatcherRequest type

func (*AddProvisionWatcherRequest) Validate 

func (pw *AddProvisionWatcherRequest) Validate() error

Validate satisfies the Validator interface

type AddRegistrationRequest 

type AddRegistrationRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Registration          dtos.Registration `json:"registration"`
}

AddRegistrationRequest defines the Request Content for POST Registration DTO.

func (*AddRegistrationRequest) UnmarshalJSON 

func (r *AddRegistrationRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddRegistrationRequest type

func (*AddRegistrationRequest) Validate 

func (r *AddRegistrationRequest) Validate() error

Validate satisfies the Validator interface

type AddSubscriptionRequest 

type AddSubscriptionRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Subscription          dtos.Subscription `json:"subscription"`
}

AddSubscriptionRequest defines the Request Content for POST Subscription DTO.

func NewAddSubscriptionRequest 

func NewAddSubscriptionRequest(dto dtos.Subscription) AddSubscriptionRequest

func (*AddSubscriptionRequest) UnmarshalJSON 

func (request *AddSubscriptionRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddSubscriptionRequest type

func (AddSubscriptionRequest) Validate 

func (request AddSubscriptionRequest) Validate() error

Validate satisfies the Validator interface

type DeviceProfileBasicInfoRequest 

type DeviceProfileBasicInfoRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	BasicInfo             dtos.UpdateDeviceProfileBasicInfo `json:"basicinfo"`
}

DeviceProfileBasicInfoRequest defines the Request Content for PATCH UpdateDeviceProfileBasicInfo DTO.

func (*DeviceProfileBasicInfoRequest) UnmarshalJSON 

func (d *DeviceProfileBasicInfoRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateDeviceRequest type

func (DeviceProfileBasicInfoRequest) Validate 

func (d DeviceProfileBasicInfoRequest) Validate() error

Validate satisfies the Validator interface

type DeviceProfileRequest 

type DeviceProfileRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Profile               dtos.DeviceProfile `json:"profile"`
}

DeviceProfileRequest defines the Request Content for POST DeviceProfile DTO.

func NewDeviceProfileRequest 

func NewDeviceProfileRequest(dto dtos.DeviceProfile) DeviceProfileRequest

func (*DeviceProfileRequest) UnmarshalJSON 

func (dp *DeviceProfileRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the DeviceProfileRequest type

func (DeviceProfileRequest) Validate 

func (dp DeviceProfileRequest) Validate() error

Validate satisfies the Validator interface

type OperationRequest 

type OperationRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ServiceName           string `json:"serviceName" validate:"required"`
	Action                string `json:"action" validate:"oneof='start' 'stop' 'restart'"`
}

OperationRequest defines the Request Content for SMA POST Operation.

func (*OperationRequest) UnmarshalJSON 

func (o *OperationRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the OperationRequest type

func (*OperationRequest) Validate 

func (o *OperationRequest) Validate() error

Validate satisfies the Validator interface

type ProfileScanRequest 

type ProfileScanRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	DeviceName            string `json:"deviceName" validate:"required"`
	ProfileName           string `json:"profileName,omitempty"`
	Options               any    `json:"options,omitempty"`
}

ProfileScanRequest is the struct for requesting a profile for a specified device.

func (*ProfileScanRequest) UnmarshalJSON 

func (psr *ProfileScanRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the AddDeviceCommandRequest type

func (ProfileScanRequest) Validate 

func (request ProfileScanRequest) Validate() error

Validate satisfies the Validator interface

type UpdateDeviceCommandRequest 

type UpdateDeviceCommandRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProfileName           string                   `json:"profileName" validate:"required,edgex-dto-none-empty-string"`
	DeviceCommand         dtos.UpdateDeviceCommand `json:"deviceCommand"`
}

UpdateDeviceCommandRequest defines the Request Content for PATCH DeviceCommand DTO.

func (*UpdateDeviceCommandRequest) UnmarshalJSON 

func (dc *UpdateDeviceCommandRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateDeviceCommandRequest type

func (UpdateDeviceCommandRequest) Validate 

func (request UpdateDeviceCommandRequest) Validate() error

Validate satisfies the Validator interface

type UpdateDeviceRequest 

type UpdateDeviceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Device                dtos.UpdateDevice `json:"device"`
}

UpdateDeviceRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateDeviceRequest 

func NewUpdateDeviceRequest(dto dtos.UpdateDevice) UpdateDeviceRequest

func (*UpdateDeviceRequest) UnmarshalJSON 

func (d *UpdateDeviceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateDeviceRequest type

func (UpdateDeviceRequest) Validate 

func (d UpdateDeviceRequest) Validate() error

Validate satisfies the Validator interface

type UpdateDeviceResourceRequest 

type UpdateDeviceResourceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProfileName           string                    `json:"profileName" validate:"required,edgex-dto-none-empty-string"`
	Resource              dtos.UpdateDeviceResource `json:"resource"`
}

UpdateDeviceResourceRequest defines the Request Content for PATCH DeviceResource DTO.

func (*UpdateDeviceResourceRequest) UnmarshalJSON 

func (dr *UpdateDeviceResourceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateDeviceResourceRequest type

func (UpdateDeviceResourceRequest) Validate 

func (request UpdateDeviceResourceRequest) Validate() error

type UpdateDeviceServiceRequest 

type UpdateDeviceServiceRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Service               dtos.UpdateDeviceService `json:"service"`
}

UpdateDeviceServiceRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateDeviceServiceRequest 

func NewUpdateDeviceServiceRequest(dto dtos.UpdateDeviceService) UpdateDeviceServiceRequest

func (*UpdateDeviceServiceRequest) UnmarshalJSON 

func (ds *UpdateDeviceServiceRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateDeviceServiceRequest type

func (UpdateDeviceServiceRequest) Validate 

func (ds UpdateDeviceServiceRequest) Validate() error

Validate satisfies the Validator interface

type UpdateIntervalActionRequest 

type UpdateIntervalActionRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Action                dtos.UpdateIntervalAction `json:"action"`
}

UpdateIntervalActionRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateIntervalActionRequest 

func NewUpdateIntervalActionRequest(dto dtos.UpdateIntervalAction) UpdateIntervalActionRequest

func (*UpdateIntervalActionRequest) UnmarshalJSON 

func (request *UpdateIntervalActionRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateIntervalActionRequest type

func (UpdateIntervalActionRequest) Validate 

func (request UpdateIntervalActionRequest) Validate() error

Validate satisfies the Validator interface

type UpdateIntervalRequest 

type UpdateIntervalRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Interval              dtos.UpdateInterval `json:"interval"`
}

UpdateIntervalRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateIntervalRequest 

func NewUpdateIntervalRequest(dto dtos.UpdateInterval) UpdateIntervalRequest

func (*UpdateIntervalRequest) UnmarshalJSON 

func (request *UpdateIntervalRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateIntervalRequest type

func (UpdateIntervalRequest) Validate 

func (request UpdateIntervalRequest) Validate() error

Validate satisfies the Validator interface

type UpdateKeysRequest 

type UpdateKeysRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Value                 any `json:"value,omitempty"`
}

UpdateKeysRequest defines the Request Content for PUT Key DTO.

func (*UpdateKeysRequest) UnmarshalJSON 

func (u *UpdateKeysRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateKeysRequest type

func (UpdateKeysRequest) Validate 

func (u UpdateKeysRequest) Validate() errors.EdgeX

Validate checks if the fields are valid of the UpdateKeysRequest struct

type UpdateProvisionWatcherRequest 

type UpdateProvisionWatcherRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	ProvisionWatcher      dtos.UpdateProvisionWatcher `json:"provisionWatcher"`
}

UpdateProvisionWatcherRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateProvisionWatcherRequest 

func NewUpdateProvisionWatcherRequest(dto dtos.UpdateProvisionWatcher) UpdateProvisionWatcherRequest

func (*UpdateProvisionWatcherRequest) UnmarshalJSON 

func (pw *UpdateProvisionWatcherRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateProvisionWatcherRequest type

func (*UpdateProvisionWatcherRequest) Validate 

func (pw *UpdateProvisionWatcherRequest) Validate() error

Validate satisfies the Validator interface

type UpdateSubscriptionRequest 

type UpdateSubscriptionRequest struct {
	dtoCommon.BaseRequest `json:",inline"`
	Subscription          dtos.UpdateSubscription `json:"subscription"`
}

UpdateSubscriptionRequest defines the Request Content for PUT event as pushed DTO.

func NewUpdateSubscriptionRequest 

func NewUpdateSubscriptionRequest(dto dtos.UpdateSubscription) UpdateSubscriptionRequest

func (*UpdateSubscriptionRequest) UnmarshalJSON 

func (request *UpdateSubscriptionRequest) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface for the UpdateSubscriptionRequest type

func (UpdateSubscriptionRequest) Validate 

func (request UpdateSubscriptionRequest) Validate() error

Validate satisfies the Validator interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.