responses

package
v3.2.0-dev.20 Latest Latest
Warning

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

 Go to latest Published: May 7, 2024 License: Apache-2.0 Imports: 8 Imported by: 6

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.

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.

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.

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.

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.

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.

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.

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.

func NewIntervalResponse 

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

type KeysResponse 

type KeysResponse struct {
	common.BaseResponse `json:",inline"`
	Response            []models.KeyOnly `json:"response"`
}

KeysResponse defines the Response Content for DELETE Keys controller of core-keeper (DELETE /kvs/key/{key} API). This DTO also defines the Response Content obtained from GET /kvs/key/{key} API with keyOnly is true.

func NewKeysResponse 

func NewKeysResponse(requestId string, message string, statusCode int, keys []models.KeyOnly) KeysResponse

type MultiDeviceCoreCommandsResponse 

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

MultiDeviceCoreCommandsResponse defines the Response Content for GET multiple DeviceCoreCommand DTOs.

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.

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.

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.

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.

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.

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.

func NewMultiIntervalsResponse 

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

type MultiKVResponse 

type MultiKVResponse struct {
	common.BaseResponse `json:",inline"`
	Response            []models.KVResponse `json:"response"`
}

MultiKVResponse defines the Response Content for GET Keys of core-keeper (GET /kvs/key/{key} API).

func NewMultiKVResponse 

func NewMultiKVResponse(requestId string, message string, statusCode int, resp []models.KVResponse) MultiKVResponse

type MultiKeyValueResponse 

type MultiKeyValueResponse struct {
	common.BaseResponse `json:",inline"`
	Response            []models.KVS `json:"response"`
}

MultiKeyValueResponse defines the Response DTO for ValuesByKey HTTP client. This DTO is obtained from GET /kvs/key/{key} API with keyOnly is false.

type MultiNotificationsResponse 

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

MultiNotificationsResponse defines the Response Content for GET multiple Notification DTOs.

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.

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.

func NewMultiReadingsResponse 

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

type MultiRegistrationsResponse 

type MultiRegistrationsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Registrations                     []dtos.Registration `json:"registrations"`
}

func NewMultiRegistrationsResponse 

func NewMultiRegistrationsResponse(requestId string, message string, statusCode int, totalCount uint32, registrations []dtos.Registration) MultiRegistrationsResponse

type MultiSubscriptionsResponse 

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

MultiSubscriptionsResponse defines the Subscription Content for GET multiple Subscription DTOs.

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.

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.

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.

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.

func NewReadingResponse 

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

type RegistrationResponse 

type RegistrationResponse struct {
	common.BaseResponse `json:",inline"`
	Registration        dtos.Registration `json:"registration"`
}

func NewRegistrationResponse 

func NewRegistrationResponse(requestId string, message string, statusCode int, r dtos.Registration) RegistrationResponse

type SubscriptionResponse 

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

SubscriptionResponse defines the Subscription Content for GET Subscription DTOs.

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.

func NewTransmissionResponse 

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

type UnitsOfMeasureResponse 

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

func NewUnitsOfMeasureResponse 

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.