Documentation
¶
Index ¶
- Constants
- type Client
- type ClientImpl
- func (c *ClientImpl) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (result model.DeviceGroupHelperResult, code int, err error)
- func (c *ClientImpl) GetBulkSelectablesV2(token string, bulk model.BulkRequestV2, options *GetBulkSelectablesOptions) (model.BulkResult, int, error)
- func (c *ClientImpl) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, ...) ([]model.Selectable, int, error)
- type DeviceGroupHelperOptions
- type GetBulkSelectablesOptions
- type GetSelectablesOptions
- type TestClient
- func (c *TestClient) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (model.DeviceGroupHelperResult, int, error)
- func (c *TestClient) GetBulkSelectablesV2(token string, bulk model.BulkRequestV2, options *GetBulkSelectablesOptions) (model.BulkResult, int, error)
- func (c *TestClient) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, ...) ([]model.Selectable, int, error)
- func (c *TestClient) SetBulkResponse(value model.BulkResult, code int, err error)
- func (c *TestClient) SetDeviceGroupHelperResponse(value model.DeviceGroupHelperResult, code int, err error)
- func (c *TestClient) SetResponse(value []model.Selectable, code int, err error)
Constants ¶
const InternalAdminToken = `` /* 727-byte string literal not displayed */
InternalAdminToken is expired and invalid. but because this service does not validate the received tokens, it may be used by trusted internal services which are within the same network (kubernetes cluster). requests with this token may not be routed over an ingres with token validation
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client interface {
GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, options *GetSelectablesOptions) ([]model.Selectable, int, error)
GetBulkSelectablesV2(token string, bulk model.BulkRequestV2, options *GetBulkSelectablesOptions) (model.BulkResult, int, error)
DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (model.DeviceGroupHelperResult, int, error)
}
type ClientImpl ¶
type ClientImpl struct {
// contains filtered or unexported fields
}
func (*ClientImpl) DeviceGroupHelper ¶
func (c *ClientImpl) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (result model.DeviceGroupHelperResult, code int, err error)
func (*ClientImpl) GetBulkSelectablesV2 ¶
func (c *ClientImpl) GetBulkSelectablesV2(token string, bulk model.BulkRequestV2, options *GetBulkSelectablesOptions) (model.BulkResult, int, error)
GetBulkSelectablesV2 asks for the selectables of several criteria sets in one request. Each element of the answer carries the id its request element had, so a caller that named them after something of its own - a bpmn element, say - can match the result back to it without relying on the order.
func (*ClientImpl) GetSelectables ¶
func (c *ClientImpl) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, options *GetSelectablesOptions) ([]model.Selectable, int, error)
type GetBulkSelectablesOptions ¶
type GetBulkSelectablesOptions struct {
// CompleteServices adds the full import type and the import path options to the answer.
// Device services are complete either way; the name is a legacy artefact of the endpoint.
CompleteServices bool
}
type GetSelectablesOptions ¶
type TestClient ¶
type TestClient struct {
// contains filtered or unexported fields
}
func NewTestClient ¶
func NewTestClient() *TestClient
func (*TestClient) DeviceGroupHelper ¶
func (c *TestClient) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (model.DeviceGroupHelperResult, int, error)
func (*TestClient) GetBulkSelectablesV2 ¶
func (c *TestClient) GetBulkSelectablesV2(token string, bulk model.BulkRequestV2, options *GetBulkSelectablesOptions) (model.BulkResult, int, error)
GetBulkSelectablesV2 answers every request element with the same selectables, unless a bulk result was set explicitly. Answering per element is what a caller that keys the result by id needs, so the fallback keeps the ids of the request rather than returning an empty list.
func (*TestClient) GetSelectables ¶
func (c *TestClient) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, options *GetSelectablesOptions) ([]model.Selectable, int, error)
func (*TestClient) SetBulkResponse ¶
func (c *TestClient) SetBulkResponse(value model.BulkResult, code int, err error)
func (*TestClient) SetDeviceGroupHelperResponse ¶
func (c *TestClient) SetDeviceGroupHelperResponse(value model.DeviceGroupHelperResult, code int, err error)
func (*TestClient) SetResponse ¶
func (c *TestClient) SetResponse(value []model.Selectable, code int, err error)