client

package
v0.0.0-...-b9360c4 Latest Latest
Warning

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

 Go to latest Published: Dec 15, 2023 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildDeviceSummaryPayload 

func BuildDeviceSummaryPayload(dataDeviceSummaryDeviceID string, dataDeviceSummaryAuth string) (*data.DeviceSummaryPayload, error)

BuildDeviceSummaryPayload builds the payload for the data device summary endpoint from CLI flags.

func DecodeDeviceSummaryResponse 

func DecodeDeviceSummaryResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (interface{}, error)

DecodeDeviceSummaryResponse returns a decoder for responses returned by the data device summary endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeDeviceSummaryResponse may return the following errors:

  • "unauthorized" (type *goa.ServiceError): http.StatusUnauthorized
  • "forbidden" (type *goa.ServiceError): http.StatusForbidden
  • "not-found" (type *goa.ServiceError): http.StatusNotFound
  • "bad-request" (type *goa.ServiceError): http.StatusBadRequest
  • error: internal error

func DeviceSummaryDataPath 

func DeviceSummaryDataPath(deviceID string) string

DeviceSummaryDataPath returns the URL path to the data service device summary HTTP endpoint.

func EncodeDeviceSummaryRequest 

func EncodeDeviceSummaryRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, interface{}) error

EncodeDeviceSummaryRequest returns an encoder for requests sent to the data device summary server.

func NewDeviceSummaryBadRequest 

func NewDeviceSummaryBadRequest(body *DeviceSummaryBadRequestResponseBody) *goa.ServiceError

NewDeviceSummaryBadRequest builds a data service device summary endpoint bad-request error.

func NewDeviceSummaryDeviceDataSummaryResponseOK 

func NewDeviceSummaryDeviceDataSummaryResponseOK(body *DeviceSummaryResponseBody) *dataviews.DeviceDataSummaryResponseView

NewDeviceSummaryDeviceDataSummaryResponseOK builds a "data" service "device summary" endpoint result from a HTTP "OK" response.

func NewDeviceSummaryForbidden 

func NewDeviceSummaryForbidden(body *DeviceSummaryForbiddenResponseBody) *goa.ServiceError

NewDeviceSummaryForbidden builds a data service device summary endpoint forbidden error.

func NewDeviceSummaryNotFound 

func NewDeviceSummaryNotFound(body *DeviceSummaryNotFoundResponseBody) *goa.ServiceError

NewDeviceSummaryNotFound builds a data service device summary endpoint not-found error.

func NewDeviceSummaryUnauthorized 

func NewDeviceSummaryUnauthorized(body *DeviceSummaryUnauthorizedResponseBody) *goa.ServiceError

NewDeviceSummaryUnauthorized builds a data service device summary endpoint unauthorized error.

func ValidateDeviceDataSummaryResponseBody 

func ValidateDeviceDataSummaryResponseBody(body *DeviceDataSummaryResponseBody) (err error)

ValidateDeviceDataSummaryResponseBody runs the validations defined on DeviceDataSummaryResponseBody

func ValidateDeviceMetaSummaryResponseBody 

func ValidateDeviceMetaSummaryResponseBody(body *DeviceMetaSummaryResponseBody) (err error)

ValidateDeviceMetaSummaryResponseBody runs the validations defined on DeviceMetaSummaryResponseBody

func ValidateDeviceProvisionSummaryCollectionResponseBody 

func ValidateDeviceProvisionSummaryCollectionResponseBody(body DeviceProvisionSummaryCollectionResponseBody) (err error)

ValidateDeviceProvisionSummaryCollectionResponseBody runs the validations defined on DeviceProvisionSummaryCollectionResponseBody

func ValidateDeviceProvisionSummaryResponseBody 

func ValidateDeviceProvisionSummaryResponseBody(body *DeviceProvisionSummaryResponseBody) (err error)

ValidateDeviceProvisionSummaryResponseBody runs the validations defined on DeviceProvisionSummaryResponseBody

func ValidateDeviceSummaryBadRequestResponseBody 

func ValidateDeviceSummaryBadRequestResponseBody(body *DeviceSummaryBadRequestResponseBody) (err error)

ValidateDeviceSummaryBadRequestResponseBody runs the validations defined on device summary_bad-request_response_body

func ValidateDeviceSummaryForbiddenResponseBody 

func ValidateDeviceSummaryForbiddenResponseBody(body *DeviceSummaryForbiddenResponseBody) (err error)

ValidateDeviceSummaryForbiddenResponseBody runs the validations defined on device summary_forbidden_response_body

func ValidateDeviceSummaryNotFoundResponseBody 

func ValidateDeviceSummaryNotFoundResponseBody(body *DeviceSummaryNotFoundResponseBody) (err error)

ValidateDeviceSummaryNotFoundResponseBody runs the validations defined on device summary_not-found_response_body

func ValidateDeviceSummaryUnauthorizedResponseBody 

func ValidateDeviceSummaryUnauthorizedResponseBody(body *DeviceSummaryUnauthorizedResponseBody) (err error)

ValidateDeviceSummaryUnauthorizedResponseBody runs the validations defined on device summary_unauthorized_response_body

Types

type Client 

type Client struct {
	// DeviceSummary Doer is the HTTP client used to make requests to the device
	// summary endpoint.
	DeviceSummaryDoer goahttp.Doer

	// CORS Doer is the HTTP client used to make requests to the  endpoint.
	CORSDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the data service endpoint HTTP clients.

func NewClient 

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the data service servers.

func (*Client) BuildDeviceSummaryRequest 

func (c *Client) BuildDeviceSummaryRequest(ctx context.Context, v interface{}) (*http.Request, error)

BuildDeviceSummaryRequest instantiates a HTTP request object with method and path set to call the "data" service "device summary" endpoint

func (*Client) DeviceSummary 

func (c *Client) DeviceSummary() goa.Endpoint

DeviceSummary returns an endpoint that makes HTTP requests to the data service device summary server.

type DeviceDataSummaryResponseBody 

type DeviceDataSummaryResponseBody struct {
	Size  *int64 `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	First *int64 `form:"first,omitempty" json:"first,omitempty" xml:"first,omitempty"`
	Last  *int64 `form:"last,omitempty" json:"last,omitempty" xml:"last,omitempty"`
}

DeviceDataSummaryResponseBody is used to define fields on response body types.

type DeviceMetaSummaryResponseBody 

type DeviceMetaSummaryResponseBody struct {
	Size  *int64 `form:"size,omitempty" json:"size,omitempty" xml:"size,omitempty"`
	First *int64 `form:"first,omitempty" json:"first,omitempty" xml:"first,omitempty"`
	Last  *int64 `form:"last,omitempty" json:"last,omitempty" xml:"last,omitempty"`
}

DeviceMetaSummaryResponseBody is used to define fields on response body types.

type DeviceProvisionSummaryCollectionResponseBody 

type DeviceProvisionSummaryCollectionResponseBody []*DeviceProvisionSummaryResponseBody

DeviceProvisionSummaryCollectionResponseBody is used to define fields on response body types.

type DeviceProvisionSummaryResponseBody 

type DeviceProvisionSummaryResponseBody struct {
	Generation *string                        `form:"generation,omitempty" json:"generation,omitempty" xml:"generation,omitempty"`
	Created    *int64                         `form:"created,omitempty" json:"created,omitempty" xml:"created,omitempty"`
	Updated    *int64                         `form:"updated,omitempty" json:"updated,omitempty" xml:"updated,omitempty"`
	Meta       *DeviceMetaSummaryResponseBody `form:"meta,omitempty" json:"meta,omitempty" xml:"meta,omitempty"`
	Data       *DeviceDataSummaryResponseBody `form:"data,omitempty" json:"data,omitempty" xml:"data,omitempty"`
}

DeviceProvisionSummaryResponseBody is used to define fields on response body types.

type DeviceSummaryBadRequestResponseBody 

type DeviceSummaryBadRequestResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

DeviceSummaryBadRequestResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "bad-request" error.

type DeviceSummaryForbiddenResponseBody 

type DeviceSummaryForbiddenResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

DeviceSummaryForbiddenResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "forbidden" error.

type DeviceSummaryNotFoundResponseBody 

type DeviceSummaryNotFoundResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

DeviceSummaryNotFoundResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "not-found" error.

type DeviceSummaryResponseBody 

type DeviceSummaryResponseBody struct {
	Provisions DeviceProvisionSummaryCollectionResponseBody `form:"provisions,omitempty" json:"provisions,omitempty" xml:"provisions,omitempty"`
}

DeviceSummaryResponseBody is the type of the "data" service "device summary" endpoint HTTP response body.

type DeviceSummaryUnauthorizedResponseBody 

type DeviceSummaryUnauthorizedResponseBody struct {
	// Name is the name of this class of errors.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// ID is a unique identifier for this particular occurrence of the problem.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Message is a human-readable explanation specific to this occurrence of the
	// problem.
	Message *string `form:"message,omitempty" json:"message,omitempty" xml:"message,omitempty"`
	// Is the error temporary?
	Temporary *bool `form:"temporary,omitempty" json:"temporary,omitempty" xml:"temporary,omitempty"`
	// Is the error a timeout?
	Timeout *bool `form:"timeout,omitempty" json:"timeout,omitempty" xml:"timeout,omitempty"`
	// Is the error a server-side fault?
	Fault *bool `form:"fault,omitempty" json:"fault,omitempty" xml:"fault,omitempty"`
}

DeviceSummaryUnauthorizedResponseBody is the type of the "data" service "device summary" endpoint HTTP response body for the "unauthorized" error.

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.