responses

package
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmActiveResponse 

type AlarmActiveResponse struct {
	dtoCommon.BaseResponse `json:",inline"`
	Alarms                 dtos.DeviceAlarmDTO `json:"alarms"`
}

func NewAlarmActiveResponse 

func NewAlarmActiveResponse(requestId string, message string, statusCode int, activeAlarm dtos.DeviceAlarmDTO) AlarmActiveResponse

NewAlarmActiveResponse creates a new AlarmActiveResponse instance

type AlarmHistoryResponse 

type AlarmHistoryResponse struct {
	dtoCommon.BaseResponse `json:",inline"`
	Alarms                 dtos.AlarmHistoryDTO `json:"alarms"`
}

func NewAlarmHistoryResponse 

func NewAlarmHistoryResponse(requestId string, message string, statusCode int, alarm dtos.AlarmHistoryDTO) AlarmHistoryResponse

type ApplicationResponse 

type ApplicationResponse struct {
	common.BaseResponse `json:",inline"`
	Application         dtos.Application `json:"application"`
}

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 NewApplicationResponse 

func NewApplicationResponse(requestId string, message string, statusCode int, pkg dtos.Application) ApplicationResponse

type ApplicationWithLinksAndStatus 

type ApplicationWithLinksAndStatus struct {
	dtos.ApplicationWithLinks
	Links   []LinkAndStatus `json:"links"`
	Devices []dtos.Device   `json:"devices"`
}

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 DeviceHistoryResponse 

type DeviceHistoryResponse struct {
	common.BaseResponse `json:",inline"`
	DeviceHistory       dtos.DeviceHistory `json:"deviceHistory"`
}

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

func NewDeviceHistoryResponse 

func NewDeviceHistoryResponse(requestId string, message string, statusCode int, deviceHistory dtos.DeviceHistory) DeviceHistoryResponse

type DeviceModelResponse 

type DeviceModelResponse struct {
	common.BaseResponse `json:",inline"`
	DeviceModel         dtos.DeviceModel `json:"deviceModel"`
}

DEVICE MODEL

func NewDeviceModelResponse 

func NewDeviceModelResponse(requestId string, message string, statusCode int, deviceModel dtos.DeviceModel) DeviceModelResponse

type DeviceProfileListResponse 

type DeviceProfileListResponse struct {
	common.BaseResponse `json:",inline"`
	List                []string `json:"list"`
}

func NewDeviceProfileListResponse 

func NewDeviceProfileListResponse(requestId string, message string, statusCode int, list []string) DeviceProfileListResponse

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 DeviceStatusResponse 

type DeviceStatusResponse struct {
	dtoCommon.BaseResponse `json:",inline"`
	Status                 dtos.DeviceStatus `json:"status"`
}

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

func NewDeviceStatusResponse 

func NewDeviceStatusResponse(requestId string, message string, statusCode int, status dtos.DeviceStatus) DeviceStatusResponse

NewDeviceStatusResponse creates a new DeviceStatusResponse instance

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 LinkAndStatus 

type LinkAndStatus struct {
	dtos.Link
	Device *dtos.Device `json:"device,omitempty"`
}

type LinkResponse 

type LinkResponse struct {
	common.BaseResponse `json:",inline"`
	Link                dtos.Link `json:"link"`
}

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 NewLinkResponse 

func NewLinkResponse(requestId string, message string, statusCode int, pkg dtos.Link) LinkResponse

type ManufacturerResponse 

type ManufacturerResponse struct {
	common.BaseResponse `json:",inline"`
	Manufacturer        dtos.Manufacturer `json:"manufacturer"`
}

MANUFACTURER

func NewManufacturerResponse 

func NewManufacturerResponse(requestId string, message string, statusCode int, manufacturer dtos.Manufacturer) ManufacturerResponse

type MultiAlarmActiveResponse 

type MultiAlarmActiveResponse struct {
	dtoCommon.BaseWithTotalCountResponse `json:",inline"`
	Alarms                               []dtos.DeviceAlarmDTO `json:"alarms"`
}

func NewMultiAlarmActiveResponse 

func NewMultiAlarmActiveResponse(requestId string, message string, statusCode int, totalCount uint32, activeAlarms []dtos.DeviceAlarmDTO) MultiAlarmActiveResponse

NewMultiAlarmActiveResponse creates a new MultiAlarmActiveResponse instance

type MultiAlarmHistoryResponse 

type MultiAlarmHistoryResponse struct {
	dtoCommon.BaseWithTotalCountResponse `json:",inline"`
	Alarms                               []dtos.AlarmHistoryDTO `json:"alarms"`
}

func NewMultiAlarmHistoryResponse 

func NewMultiAlarmHistoryResponse(requestId string, message string, statusCode int, totalCount uint32, alarms []dtos.AlarmHistoryDTO) MultiAlarmHistoryResponse

type MultiApplicationsResponse 

type MultiApplicationsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Applications                      []dtos.Application `json:"applications"`
}

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 NewMultiApplicationResponse 

func NewMultiApplicationResponse(requestId string, message string, statusCode int, totalCount uint32, applications []dtos.Application) MultiApplicationsResponse

type MultiApplicationsWithLinksAndStatusResponse 

type MultiApplicationsWithLinksAndStatusResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Applications                      []ApplicationWithLinksAndStatus `json:"applications"`
}

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 MultiDeviceModelResponse 

type MultiDeviceModelResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	DeviceModels                      []dtos.DeviceModel `json:"deviceModels"`
}

func NewMultiDeviceModelResponse 

func NewMultiDeviceModelResponse(requestId string, message string, statusCode int, totalCount uint32, deviceModels []dtos.DeviceModel) MultiDeviceModelResponse

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 MultiDeviceStatusResponse 

type MultiDeviceStatusResponse struct {
	dtoCommon.BaseWithTotalCountResponse `json:",inline"`
	Status                               []dtos.DeviceStatus `json:"status"`
}

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

func NewMultiDeviceStatusResponse 

func NewMultiDeviceStatusResponse(requestId string, message string, statusCode int, totalCount uint32, statuses []dtos.DeviceStatus) MultiDeviceStatusResponse

NewMultiDeviceStatusResponse creates a new MultiDeviceStatusResponse instance

type MultiDevicesHistoryResponse 

type MultiDevicesHistoryResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	DevicesHistory                    []dtos.DeviceHistory `json:"devicesHistory"`
}

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

func NewMultiDevicesHistoryResponse 

func NewMultiDevicesHistoryResponse(requestId string, message string, statusCode int, totalCount uint32, devicesHistory []dtos.DeviceHistory) MultiDevicesHistoryResponse

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 MultiLabelsWithDeviceCountResponse 

type MultiLabelsWithDeviceCountResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	LabelsWithDeviceCount             []dtos.LabelsWithDeviceCount `json:"labelsByDevice"`
}

func NewMultiLabelsWithDeviceCountResponse 

func NewMultiLabelsWithDeviceCountResponse(
	requestId string,
	message string,
	statusCode int,
	totalCount uint32,
	labelsWithDevice []dtos.LabelsWithDeviceCount,
) MultiLabelsWithDeviceCountResponse

type MultiLinksResponse 

type MultiLinksResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Links                             []dtos.Link `json:"links"`
}

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 NewMultiLinkResponse 

func NewMultiLinkResponse(requestId string, message string, statusCode int, totalCount uint32, links []dtos.Link) MultiLinksResponse

type MultiManufacturerResponse 

type MultiManufacturerResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Manufacturers                     []dtos.Manufacturer `json:"manufacturers"`
}

func NewMultiManufacturerResponse 

func NewMultiManufacturerResponse(requestId string, message string, statusCode int, totalCount uint32, manufacturers []dtos.Manufacturer) MultiManufacturerResponse

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 MultiOrganizationsResponse 

type MultiOrganizationsResponse struct {
	common.BaseWithTotalCountResponse `json:",inline"`
	Organizations                     []dtos.Organization `json:"organizations"`
}

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 NewMultiOrganizationResponse 

func NewMultiOrganizationResponse(requestId string, message string, statusCode int, totalCount uint32, organizations []dtos.Organization) MultiOrganizationsResponse

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 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 OrganizationResponse 

type OrganizationResponse struct {
	common.BaseResponse `json:",inline"`
	Organization        dtos.Organization `json:"organization"`
}

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 NewOrganizationResponse 

func NewOrganizationResponse(requestId string, message string, statusCode int, pkg dtos.Organization) OrganizationResponse

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