responses

Documentation

Index

• type AddEventResponse
• type Event
• type EventCountResponse
• type EventResponse
• type ReadingCountResponse
• type ReadingResponse
• type UpdateEventPushedByChecksumResponse

Types

type AddEventResponse

type AddEventResponse struct {
	common.BaseResponse `json:",inline"`
	ID                  string `json:"id"`
}

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

type Event

type Event struct {
	ID       string             `json:"id"`
	Pushed   int64              `json:"pushed,omitempty"`
	Device   string             `json:"device"`
	Created  int64              `json:"created"`
	Modified int64              `json:"modified,omitempty"`
	Origin   int64              `json:"origin"`
	Readings []dtos.BaseReading `json:"readings"`
}

Event represents a single measurable event read from a device This object and its properties correspond to the Event object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/Event

type EventCountResponse

type EventCountResponse struct {
	common.BaseResponse `json:",inline"`
	Count               uint32
	DeviceID            string `json:"deviceId"` // ID uniquely identifies a device
}

EventCountResponse defines the Response Content for GET event count DTO. This object and its properties correspond to the EventCountResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/EventCountResponse

type EventResponse

type EventResponse struct {
	common.BaseResponse `json:",inline"`
	Event               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.x#/EventResponse

type ReadingCountResponse

type ReadingCountResponse struct {
	common.BaseResponse `json:",inline"`
	Count               uint32
}

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

type ReadingResponse

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

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.x#/ReadingResponse

type UpdateEventPushedByChecksumResponse

type UpdateEventPushedByChecksumResponse struct {
	common.BaseResponse `json:",inline"`
	Checksum            string `json:"checksum"`
}

UpdateEventPushedByChecksumResponse defines the Response Content for PUT event as pushed DTO. This object and its properties correspond to the UpdateEventPushedByChecksumResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/UpdateEventPushedByChecksumResponse