client

package
v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Index

Constants

View Source
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)
	DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (model.DeviceGroupHelperResult, int, error)
}

func NewClient

func NewClient(baseUrl string) Client

Client only implements GetSelectables and DeviceGroupHelper. Client should be extended if more API functionality is required

type ClientImpl

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

func (*ClientImpl) DeviceGroupHelper added in v1.0.0

func (c *ClientImpl) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (result model.DeviceGroupHelperResult, code int, err error)

func (*ClientImpl) GetSelectables

func (c *ClientImpl) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, options *GetSelectablesOptions) ([]model.Selectable, int, error)

type DeviceGroupHelperOptions added in v1.0.0

type DeviceGroupHelperOptions struct {
	Search                  string
	Limit                   int64 //ignored if 0; the service defaults to 100
	Offset                  int64 //ignored if 0
	MaintainsGroupUsability bool
	FunctionBlockList       []string
}

type GetSelectablesOptions

type GetSelectablesOptions struct {
	IncludeGroups               bool
	IncludeImports              bool
	IncludeDevices              bool
	IncludeIdModified           bool
	WithDeviceIds               []string
	WithLocalDeviceIds          []string
	LocalDeviceOwner            string
	FilterByDeviceAttributeKeys []string
}

type TestClient

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

func NewTestClient

func NewTestClient() *TestClient

func (*TestClient) DeviceGroupHelper added in v1.0.0

func (c *TestClient) DeviceGroupHelper(token string, deviceIds []string, options *DeviceGroupHelperOptions) (model.DeviceGroupHelperResult, int, error)

func (*TestClient) GetSelectables

func (c *TestClient) GetSelectables(token string, criteria []models.DeviceGroupFilterCriteria, options *GetSelectablesOptions) ([]model.Selectable, int, error)

func (*TestClient) SetDeviceGroupHelperResponse added in v1.0.0

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)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL