http

Documentation

Index

• type RestController
  • func NewRestController(r *mux.Router, dic *di.Container, serviceName string) *RestController
  • func (c *RestController) AddDevice(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) AddProvisionWatcher(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) AddRoute(route string, handler func(http.ResponseWriter, *http.Request), ...) errors.EdgeX
  • func (c *RestController) Config(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) DeleteDevice(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) DeleteProvisionWatcher(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) Discovery(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) GetCommand(w http.ResponseWriter, r *http.Request)
  • func (c *RestController) InitRestRoutes()
  • func (c *RestController) Metrics(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) Ping(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) Router() *mux.Router
  • func (c *RestController) Secret(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) SetCommand(w http.ResponseWriter, r *http.Request)
  • func (c *RestController) SetCustomConfigInfo(customConfig interfaces.UpdatableConfig)
  • func (c *RestController) UpdateDevice(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) UpdateDeviceService(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) UpdateProfile(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) UpdateProvisionWatcher(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) ValidateDevice(writer http.ResponseWriter, request *http.Request)
  • func (c *RestController) Version(writer http.ResponseWriter, request *http.Request)

Types

type RestController

type RestController struct {
	// contains filtered or unexported fields
}

func NewRestController

func NewRestController(r *mux.Router, dic *di.Container, serviceName string) *RestController

func (*RestController) AddDevice

func (c *RestController) AddDevice(writer http.ResponseWriter, request *http.Request)

func (*RestController) AddProvisionWatcher

func (c *RestController) AddProvisionWatcher(writer http.ResponseWriter, request *http.Request)

func (*RestController) AddRoute

func (c *RestController) AddRoute(route string, handler func(http.ResponseWriter, *http.Request), methods ...string) errors.EdgeX

func (*RestController) Config

func (c *RestController) Config(writer http.ResponseWriter, request *http.Request)

Config handles the request to /config endpoint. Is used to request the service's configuration It returns a response as specified by the V2 API swagger in openapi/common

func (*RestController) DeleteDevice

func (c *RestController) DeleteDevice(writer http.ResponseWriter, request *http.Request)

func (*RestController) DeleteProvisionWatcher

func (c *RestController) DeleteProvisionWatcher(writer http.ResponseWriter, request *http.Request)

func (*RestController) Discovery

func (c *RestController) Discovery(writer http.ResponseWriter, request *http.Request)

func (*RestController) GetCommand

func (c *RestController) GetCommand(w http.ResponseWriter, r *http.Request)

func (*RestController) InitRestRoutes

func (c *RestController) InitRestRoutes()

func (*RestController) Metrics

func (c *RestController) Metrics(writer http.ResponseWriter, request *http.Request)

Metrics handles the request to the /metrics endpoint, memory and cpu utilization stats It returns a response as specified by the V2 API swagger in openapi/common

func (*RestController) Ping

func (c *RestController) Ping(writer http.ResponseWriter, request *http.Request)

Ping handles the request to /ping endpoint. Is used to test if the service is working It returns a response as specified by the V2 API swagger in openapi/common

func (*RestController) Router

func (c *RestController) Router() *mux.Router

func (*RestController) Secret

func (c *RestController) Secret(writer http.ResponseWriter, request *http.Request)

Secret handles the request to add Device Service exclusive secret to the Secret Store It returns a response as specified by the V2 API swagger in openapi/common

func (*RestController) SetCommand

func (c *RestController) SetCommand(w http.ResponseWriter, r *http.Request)

func (*RestController) SetCustomConfigInfo

func (c *RestController) SetCustomConfigInfo(customConfig interfaces.UpdatableConfig)

SetCustomConfigInfo sets the custom configuration, which is used to include the service's custom config in the /config endpoint response.

func (*RestController) UpdateDevice

func (c *RestController) UpdateDevice(writer http.ResponseWriter, request *http.Request)

func (*RestController) UpdateDeviceService

func (c *RestController) UpdateDeviceService(writer http.ResponseWriter, request *http.Request)

func (*RestController) UpdateProfile

func (c *RestController) UpdateProfile(writer http.ResponseWriter, request *http.Request)

func (*RestController) UpdateProvisionWatcher

func (c *RestController) UpdateProvisionWatcher(writer http.ResponseWriter, request *http.Request)

func (*RestController) ValidateDevice

func (c *RestController) ValidateDevice(writer http.ResponseWriter, request *http.Request)

func (*RestController) Version

func (c *RestController) Version(writer http.ResponseWriter, request *http.Request)

Version handles the request to /version endpoint. Is used to request the service's versions It returns a response as specified by the V2 API swagger in openapi/common