responses

package
v2.3.0 Latest Latest
Warning

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

 Go to latest Published: Nov 1, 2022 License: Apache-2.0 Imports: 7 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DeviceCoreCommandResponse 

type DeviceCoreCommandResponse struct {
	common.BaseResponse `json:",inline"`
	DeviceCoreCommand   dtos.DeviceCoreCommand `json:"deviceCoreCommand"`
}

DeviceCoreCommandResponse defines the Response Content for GET DeviceCoreCommand DTO. This object and its properties correspond to the DeviceCoreCommandResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command/2.1.0#/DeviceCoreCommandResponse

func NewDeviceCoreCommandResponse 

func NewDeviceCoreCommandResponse(requestId string, message string, statusCode int, deviceCoreCommand dtos.DeviceCoreCommand) DeviceCoreCommandResponse

type DeviceProfileResponse 

type DeviceProfileResponse struct {
	common.BaseResponse `json:",inline"`
	Profile             dtos.DeviceProfile `json:"profile"`
}

DeviceProfileResponse defines the Response Content for GET DeviceProfile DTOs. This object and its properties correspond to the DeviceProfileResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/DeviceProfileResponse

func NewDeviceProfileResponse 

func NewDeviceProfileResponse(requestId string, message string, statusCode int, deviceProfile dtos.DeviceProfile) DeviceProfileResponse

type DeviceResourceResponse 

type DeviceResourceResponse struct {
	common.BaseResponse `json:",inline"`
	Resource            dtos.DeviceResource `json:"resource"`
}

DeviceResourceResponse defines the Response Content for GET DeviceResource DTOs. This object and its properties correspond to the DeviceResourceResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/DeviceResourceResponse

func NewDeviceResourceResponse 

func NewDeviceResourceResponse(requestId string, message string, statusCode int, resource dtos.DeviceResource) DeviceResourceResponse

NewDeviceResourceResponse creates deviceResource response DTO with required fields

type DeviceResponse 

type DeviceResponse struct {
	common.BaseResponse `json:",inline"`
	Device              dtos.Device `json:"device"`
}

DeviceResponse defines the Response Content for GET Device DTOs. This object and its properties correspond to the DeviceResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/DeviceResponse

func NewDeviceResponse 

func NewDeviceResponse(requestId string, message string, statusCode int, device dtos.Device) DeviceResponse

type DeviceServiceResponse 

type DeviceServiceResponse struct {
	common.BaseResponse `json:",inline"`
	Service             dtos.DeviceService `json:"service"`
}

DeviceServiceResponse defines the Response Content for GET DeviceService DTOs. This object and its properties correspond to the DeviceServiceResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/DeviceServiceResponse

func NewDeviceServiceResponse 

func NewDeviceServiceResponse(requestId string, message string, statusCode int, deviceService dtos.DeviceService) DeviceServiceResponse

type EventResponse 

type EventResponse struct {
	dtoCommon.BaseResponse `json:",inline"`
	Event                  dtos.Event `json:"event"`
}

EventResponse defines the Response Content for GET event DTOs. This object and its properties correspond to the EventResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.1.0#/EventResponse

func NewEventResponse 

func NewEventResponse(requestId string, message string, statusCode int, event dtos.Event) EventResponse

func (*EventResponse) Encode 

func (e *EventResponse) Encode() ([]byte, string, error)

type IntervalActionResponse 

type IntervalActionResponse struct {
	common.BaseResponse `json:",inline"`
	Action              dtos.IntervalAction `json:"action"`
}

IntervalActionResponse defines the Response Content for GET IntervalAction DTOs. This object and its properties correspond to the IntervalActionResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/2.1.0#/IntervalActionResponse

func NewIntervalActionResponse 

func NewIntervalActionResponse(requestId string, message string, statusCode int, action dtos.IntervalAction) IntervalActionResponse

type IntervalResponse 

type IntervalResponse struct {
	common.BaseResponse `json:",inline"`
	Interval            dtos.Interval `json:"interval"`
}

IntervalResponse defines the Response Content for GET Interval DTOs. This object and its properties correspond to the IntervalResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/2.1.0#/IntervalResponse

func NewIntervalResponse 

func NewIntervalResponse(requestId string, message string, statusCode int, interval dtos.Interval) IntervalResponse

type MultiDeviceCoreCommandsResponse 

type MultiDeviceCoreCommandsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	DeviceCoreCommands                []dtos.DeviceCoreCommand `json:"deviceCoreCommands"`
}

MultiDeviceCoreCommandsResponse defines the Response Content for GET multiple DeviceCoreCommand DTOs. This object and its properties correspond to the MultiDeviceCoreCommandsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-command/2.1.0#/MultiDeviceCoreCommandsResponse

func NewMultiDeviceCoreCommandsResponse 

func NewMultiDeviceCoreCommandsResponse(requestId string, message string, statusCode int, totalCount uint32, commands []dtos.DeviceCoreCommand) MultiDeviceCoreCommandsResponse

type MultiDeviceProfilesResponse 

type MultiDeviceProfilesResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Profiles                          []dtos.DeviceProfile `json:"profiles"`
}

MultiDeviceProfilesResponse defines the Response Content for GET multiple DeviceProfile DTOs. This object and its properties correspond to the MultiDeviceProfilesResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/MultiDeviceProfilesResponse

func NewMultiDeviceProfilesResponse 

func NewMultiDeviceProfilesResponse(requestId string, message string, statusCode int, totalCount uint32, deviceProfiles []dtos.DeviceProfile) MultiDeviceProfilesResponse

type MultiDeviceServicesResponse 

type MultiDeviceServicesResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Services                          []dtos.DeviceService `json:"services"`
}

MultiDeviceServicesResponse defines the Response Content for GET multiple DeviceService DTOs. This object and its properties correspond to the MultiDeviceServicesResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/MultiDeviceServicesResponse

func NewMultiDeviceServicesResponse 

func NewMultiDeviceServicesResponse(requestId string, message string, statusCode int, totalCount uint32, deviceServices []dtos.DeviceService) MultiDeviceServicesResponse

type MultiDevicesResponse 

type MultiDevicesResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Devices                           []dtos.Device `json:"devices"`
}

MultiDevicesResponse defines the Response Content for GET multiple Device DTOs. This object and its properties correspond to the MultiDevicesResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/MultiDevicesResponse

func NewMultiDevicesResponse 

func NewMultiDevicesResponse(requestId string, message string, statusCode int, totalCount uint32, devices []dtos.Device) MultiDevicesResponse

type MultiEventsResponse 

type MultiEventsResponse struct {
	dtoCommon.BaseWithTotalCountResponse `json:",inline"`
	Events                               []dtos.Event `json:"events"`
}

MultiEventsResponse defines the Response Content for GET multiple event DTOs. This object and its properties correspond to the MultiEventsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.1.0#/MultiEventsResponse

func NewMultiEventsResponse 

func NewMultiEventsResponse(requestId string, message string, statusCode int, totalCount uint32, events []dtos.Event) MultiEventsResponse

type MultiIntervalActionsResponse 

type MultiIntervalActionsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Actions                           []dtos.IntervalAction `json:"actions"`
}

MultiIntervalActionsResponse defines the Response Content for GET multiple IntervalAction DTOs. This object and its properties correspond to the MultiIntervalActionsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/2.1.0#/MultiIntervalActionsResponse

func NewMultiIntervalActionsResponse 

func NewMultiIntervalActionsResponse(requestId string, message string, statusCode int, totalCount uint32, actions []dtos.IntervalAction) MultiIntervalActionsResponse

type MultiIntervalsResponse 

type MultiIntervalsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Intervals                         []dtos.Interval `json:"intervals"`
}

MultiIntervalsResponse defines the Response Content for GET multiple Interval DTOs. This object and its properties correspond to the MultiIntervalsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-scheduler/2.1.0#/MultiIntervalsResponse

func NewMultiIntervalsResponse 

func NewMultiIntervalsResponse(requestId string, message string, statusCode int, totalCount uint32, intervals []dtos.Interval) MultiIntervalsResponse

type MultiNotificationsResponse 

type MultiNotificationsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Notifications                     []dtos.Notification `json:"notifications"`
}

MultiNotificationsResponse defines the Response Content for GET multiple Notification DTOs. This object and its properties correspond to the MultiNotificationsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/MultiNotificationsResponse

func NewMultiNotificationsResponse 

func NewMultiNotificationsResponse(requestId string, message string, statusCode int, totalCount uint32, notifications []dtos.Notification) MultiNotificationsResponse

type MultiProvisionWatchersResponse 

type MultiProvisionWatchersResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	ProvisionWatchers                 []dtos.ProvisionWatcher `json:"provisionWatchers"`
}

MultiProvisionWatchersResponse defines the Response Content for GET multiple ProvisionWatcher DTOs. This object and its properties correspond to the MultiProvisionWatchersResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/MultiProvisionWatchersResponse

func NewMultiProvisionWatchersResponse 

func NewMultiProvisionWatchersResponse(requestId string, message string, statusCode int, totalCount uint32, pws []dtos.ProvisionWatcher) MultiProvisionWatchersResponse

type MultiReadingsResponse 

type MultiReadingsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Readings                          []dtos.BaseReading `json:"readings"`
}

MultiReadingsResponse defines the Response Content for GET multiple reading DTO. This object and its properties correspond to the MultiReadingsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.1.0#/MultiReadingsResponse

func NewMultiReadingsResponse 

func NewMultiReadingsResponse(requestId string, message string, statusCode int, totalCount uint32, readings []dtos.BaseReading) MultiReadingsResponse

type MultiSubscriptionsResponse 

type MultiSubscriptionsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Subscriptions                     []dtos.Subscription `json:"subscriptions"`
}

MultiSubscriptionsResponse defines the Subscription Content for GET multiple Subscription DTOs. This object and its properties correspond to the MultiSubscriptionsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/MultiSubscriptionsResponse

func NewMultiSubscriptionsResponse 

func NewMultiSubscriptionsResponse(requestId string, message string, statusCode int, totalCount uint32, subscriptions []dtos.Subscription) MultiSubscriptionsResponse

type MultiTransmissionsResponse 

type MultiTransmissionsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Transmissions                     []dtos.Transmission `json:"transmissions"`
}

MultiTransmissionsResponse defines the Response Content for GET multiple Transmission DTOs. This object and its properties correspond to the MultiNotificationsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/MultiTransmissionsResponse

func NewMultiTransmissionsResponse 

func NewMultiTransmissionsResponse(requestId string, message string, statusCode int, totalCount uint32, transmissions []dtos.Transmission) MultiTransmissionsResponse

type NotificationResponse 

type NotificationResponse struct {
	common.BaseResponse `json:",inline"`
	Notification        dtos.Notification `json:"notification"`
}

NotificationResponse defines the Response Content for GET Notification DTO. This object and its properties correspond to the NotificationResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/NotificationResponse

func NewNotificationResponse 

func NewNotificationResponse(requestId string, message string, statusCode int,
	notification dtos.Notification) NotificationResponse

type ProvisionWatcherResponse 

type ProvisionWatcherResponse struct {
	common.BaseResponse `json:",inline"`
	ProvisionWatcher    dtos.ProvisionWatcher `json:"provisionWatcher"`
}

ProvisionWatcherResponse defines the Response Content for GET ProvisionWatcher DTOs. This object and its properties correspond to the ProvisionWatcherResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-metadata/2.1.0#/ProvisionWatcherResponse

func NewProvisionWatcherResponse 

func NewProvisionWatcherResponse(requestId string, message string, statusCode int, pw dtos.ProvisionWatcher) ProvisionWatcherResponse

type ReadingResponse 

type ReadingResponse struct {
	common.BaseResponse `json:",inline"`
	Reading             dtos.BaseReading `json:"reading"`
}

ReadingResponse defines the Response Content for GET reading DTO. This object and its properties correspond to the ReadingResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.1.0#/ReadingResponse

func NewReadingResponse 

func NewReadingResponse(requestId string, message string, statusCode int, reading dtos.BaseReading) ReadingResponse

type SubscriptionResponse 

type SubscriptionResponse struct {
	common.BaseResponse `json:",inline"`
	Subscription        dtos.Subscription `json:"subscription"`
}

SubscriptionResponse defines the Subscription Content for GET Subscription DTOs. This object and its properties correspond to the SubscriptionResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/SubscriptionResponse

func NewSubscriptionResponse 

func NewSubscriptionResponse(requestId string, message string, statusCode int,
	subscription dtos.Subscription) SubscriptionResponse

type TransmissionResponse 

type TransmissionResponse struct {
	common.BaseResponse `json:",inline"`
	Transmission        dtos.Transmission `json:"transmission"`
}

TransmissionResponse defines the Response Content for GET Transmission DTO. This object and its properties correspond to the NotificationResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/support-notifications/2.1.0#/TransmissionResponse

func NewTransmissionResponse 

func NewTransmissionResponse(requestId string, message string, statusCode int,
	transmission dtos.Transmission) TransmissionResponse

type UnitsOfMeasureResponse added in v2.3.0 

type UnitsOfMeasureResponse struct {
	common.BaseResponse `json:",inline"`
	Uom                 any `json:"uom"`
}

func NewUnitsOfMeasureResponse added in v2.3.0 

func NewUnitsOfMeasureResponse(requestId string, message string, statusCode int, uom any) UnitsOfMeasureResponse

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.