common

type BaseRequest ¶

type BaseRequest struct {
	RequestId string `json:"requestId" validate:"len=0|uuid"`
}

Request defines the base content for request DTOs (data transfer objects). This object and its properties correspond to the BaseRequest object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/BaseRequest

type BaseResponse ¶

type BaseResponse struct {
	Versionable `json:",inline"`
	RequestId   string      `json:"requestId"`
	Message     interface{} `json:"message,omitempty"`
	StatusCode  int         `json:"statusCode"`
}

BaseResponse defines the base content for response DTOs (data transfer objects). This object and its properties correspond to the BaseResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/BaseResponse

func NewBaseResponse(requestId string, message string, statusCode int) BaseResponse

type BaseWithIdResponse ¶ added in v0.1.67

type BaseWithIdResponse struct {
	BaseResponse `json:",inline"`
	Id           string `json:"id"`
}

BaseWithIdResponse defines the base content for response DTOs (data transfer objects). This object and its properties correspond to the BaseWithIdResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/BaseWithIdResponse

func NewBaseWithIdResponse(requestId string, message string, statusCode int, id string) BaseWithIdResponse

type ConfigResponse ¶

type ConfigResponse struct {
	Versionable `json:",inline"`
	Config      interface{} `json:"config"`
}

ConfigResponse defines the configuration for the targeted service. This object and its properties correspond to the ConfigResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/ConfigResponse

func NewConfigResponse(serviceConfig interface{}) ConfigResponse

type CountResponse ¶ added in v0.1.116

type CountResponse struct {
	BaseResponse `json:",inline"`
	Count        uint32
}

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

func NewCountResponse(requestId string, message string, statusCode int, count uint32) CountResponse

type Metrics ¶ added in v0.1.66

type Metrics struct {
	MemAlloc       uint64 `json:"memAlloc"`
	MemFrees       uint64 `json:"memFrees"`
	MemLiveObjects uint64 `json:"memLiveObjects"`
	MemMallocs     uint64 `json:"memMallocs"`
	MemSys         uint64 `json:"memSys"`
	MemTotalAlloc  uint64 `json:"memTotalAlloc"`
	CpuBusyAvg     uint8  `json:"cpuBusyAvg"`
}

type MetricsResponse ¶

type MetricsResponse struct {
	Versionable `json:",inline"`
	Metrics     Metrics `json:"metrics"`
}

MetricsResponse defines the providing memory and cpu utilization stats of the service. This object and its properties correspond to the MetricsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/MetricsResponse

func NewMetricsResponse(metrics Metrics) MetricsResponse

type PingResponse ¶

type PingResponse struct {
	Versionable `json:",inline"`
	Timestamp   string `json:"timestamp"`
}

PingResponse defines the content of response content for POST Ping DTO This object and its properties correspond to the Ping object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/PingResponse

func NewPingResponse() PingResponse

type SecretsKeyValue ¶ added in v0.1.136

type SecretsKeyValue struct {
	Key   string `json:"key" validate:"required"`
	Value string `json:"value" validate:"required"`
}

SecretsKeyValue is a secret key/value pair to be stored in the Secret Store See detail specified by the V2 API swagger in openapi/v2

type SecretsRequest ¶ added in v0.1.136

type SecretsRequest struct {
	BaseRequest `json:",inline"`
	Path        string            `json:"path" validate:"required"`
	Secrets     []SecretsKeyValue `json:"secrets" validate:"required,gt=0,dive"`
}

SecretsRequest is the request DTO for storing supplied secrets at specified Path in the Secret Store See detail specified by the V2 API swagger in openapi/v2

func (sr *SecretsRequest) UnmarshalJSON(b []byte) error

func (sr SecretsRequest) Validate() error

type VersionResponse ¶

type VersionResponse struct {
	Versionable `json:",inline"`
	Version     string `json:"version"`
}

VersionResponse defines the latest version supported by the service. This object and its properties correspond to the VersionResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/VersionResponse

func NewVersionResponse(version string) VersionResponse

type VersionSdkResponse ¶

type VersionSdkResponse struct {
	VersionResponse `json:",inline"`
	SdkVersion      string `json:"sdk_version"`
}

VersionSdkResponse defines the latest sdk version supported by the service. This object and its properties correspond to the VersionSdkResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/VersionSdkResponse

func NewVersionSdkResponse(appVersion string, sdkVersion string) VersionSdkResponse

type Versionable ¶ added in v0.1.65

type Versionable struct {
	ApiVersion string `json:"apiVersion,omitempty"`
}

Versionable shows the API version in DTOs

func NewVersionable() Versionable