api

package

Go to main page

Versions in this module

v1

v1.14.0

Jun 5, 2024

v1.13.2

May 23, 2024

v1.13.1

May 22, 2024

v1.13.0

May 21, 2024

v1.12.1

Apr 18, 2024

v1.12.0

Jan 15, 2024

v1.11.2

Dec 7, 2023

v1.11.1

Dec 4, 2023

v1.11.0

Nov 23, 2023

v1.10.4

Nov 3, 2023

v1.10.3

Nov 2, 2023

v1.10.2

Oct 31, 2023

v1.10.1

Oct 31, 2023

v1.10.0

Oct 25, 2023

v1.9.2

Oct 10, 2023

v1.9.1

Oct 6, 2023

v1.9.0

Oct 6, 2023

v1.8.1

Sep 1, 2023

Changes in this version

type APIClient

+ ColumnExists func(entity, sampler, view, name string) (bool, error)

+ CreateColumn func(entity, sampler, view, name string) error

+ CreateHeadline func(entity, sampler, view, name string) error

+ DeleteHeadline func(entity, sampler, view, name string) error

+ HeadlineExists func(entity, sampler, view, name string) (bool, error)

+ ManagedEntityExists func(entity string) (bool, error)

+ RowExists func(entity, sampler, view, name string) (bool, error)

+ SamplerExists func(entity, sampler string) (bool, error)

+ UpdateHeadline func(entity, sampler, view, name, value string) error

type Plugin

+ func NewSampler(c APIClient, name, entity, sampler string) (s *Plugin)

type RESTClient

+ func (c *RESTClient) ColumnExists(entity, sampler, view, name string) (bool, error)

+ func (c *RESTClient) CreateColumn(entity, sampler, view, name string) (err error)

+ func (c *RESTClient) CreateHeadline(entity, sampler, view, name string) (err error)

+ func (c *RESTClient) DeleteHeadline(entity, sampler, view, name string) (err error)

+ func (c *RESTClient) HeadlineExists(entity, sampler, view, name string) (bool, error)

+ func (c *RESTClient) ManagedEntityExists(entity string) (bool, error)

+ func (c *RESTClient) RowExists(entity, sampler, view, name string) (bool, error)

+ func (c *RESTClient) SamplerExists(entity, sampler string) (bool, error)

+ func (c *RESTClient) UpdateHeadline(entity, sampler, view, name, value string) (err error)

+ type Sampler interface

+ Close func() error

+ Interval func() time.Duration

+ Open func() error

+ Pause func() error

+ SampleNow func() error

+ SetInterval func(time.Duration)

+ Start func() error

+ type Stream struct

+ func OpenStream(c APIClient, entity, sampler, stream string) (s *Stream, err error)

+ func (s *Stream) Write(data []byte) (n int, err error)

type XMLRPCClient

+ func (c *XMLRPCClient) CreateColumn(entity, sampler, view, name string) (err error)

+ func (c *XMLRPCClient) CreateHeadline(entity, sampler, view, name string) (err error)

+ func (c *XMLRPCClient) DeleteHeadline(entity, sampler, view, name string) (err error)

v1.8.0

Aug 16, 2023

Changes in this version

+ const COLUMN_EXISTS

+ const COLUMN_MISMATCH

+ const GATEWAY_NOT_CONNECTED

+ const GATEWAY_NOT_SUPPORTED

+ const HEADLINE_EXISTS

+ const HOST_NOT_TRUSTED

+ const MISC_ERROR

+ const NO_SUCH_CELL

+ const NO_SUCH_COLUMN

+ const NO_SUCH_HEADLINE

+ const NO_SUCH_METHOD

+ const NO_SUCH_ROW

+ const NO_SUCH_SAMPLER

+ const NO_SUCH_STREAM

+ const NO_SUCH_VIEW

+ const NO_XML_SENT

+ const NUMBER_OUT_OF_RANGE

+ const ROW_EXISTS

+ const SAMPLER_INACTIVE

+ const SAMPLER_PARAM_NOT_FOUND

+ const STREAM_BUFFER_FULL

+ const VIEW_AND_GROUP_EQUAL

+ const VIEW_EXISTS

+ const WRONG_PARAM_COUNT

+ var ErrInvalidArgs = errors.New("invalid arguments")

+ func Attach(c APIClient, name, entity, sampler, group string)

+ func RegisterPlugin(name string, plugin Plugin)

+ type APIClient interface

+ CreateDataview func(entity, sampler, name string) error

+ CreateRow func(entity, sampler, view, name string) error

+ CreateStream func(entity, sampler, name string) error

+ DataviewExists func(entity, sampler, name string) (bool, error)

+ DeleteDataview func(entity, sampler, name string) error

+ DeleteRow func(entity, sampler, view, name string) error

+ Healthy func() bool

+ UpdateDataview func(entity, sampler, name string, values [][]string) error

+ UpdateRow func(entity, sampler, view, name string, values []string) error

+ UpdateStream func(entity, sampler, name, message string) error

+ func NewRESTClient(endpoint string, options ...Options) (c APIClient, err error)

+ func NewXMLRPCClient(endpoint string, options ...Options) (c APIClient, err error)

+ type Client struct

+ type Columns map[string]columndetails

+ func ColumnInfo(rowdata interface{}) (cols Columns, columnnames []string, sorting string, err error)

+ type Dataview struct

+ Entity string

+ Name string

+ Sampler string

+ func NewDataview(c Client, entity, sampler, typeName, viewName, groupHeading string) (view *Dataview, err error)

+ func (view *Dataview) Exists() (exists bool, err error)

+ func (view *Dataview) RowsFromMap(rowdata interface{}) (rows [][]string, err error)

+ func (view *Dataview) RowsFromSlice(rowdata interface{}) (rows [][]string, err error)

+ func (view *Dataview) Update() (err error)

+ func (view *Dataview) UpdateTableFromMap(data interface{}) error

+ func (view *Dataview) UpdateTableFromMapDelta(newdata, olddata interface{}, interval time.Duration) error

+ func (view *Dataview) UpdateTableFromSlice(rowdata interface{}) error

+ func (view Dataview) RowsFromMapDelta(newrowdata, oldrowdata interface{}, interval time.Duration) (rows [][]string, err error)

+ type Options func(*apiOptions)

+ func InsecureSkipVerify() Options

+ type Plugin interface

+ Init func()

+ Interval func() time.Duration

+ SampleNow func() error

+ SetInterval func(time.Duration)

+ Start func() error

+ Stop func() error

+ func FindPlugin(name string) (plugin Plugin)

+ type RESTClient struct

+ func (c *RESTClient) CreateDataview(entity, sampler, name string) (err error)

+ func (c *RESTClient) CreateRow(entity, sampler, view, name string) (err error)

+ func (c *RESTClient) CreateStream(entity, sampler, name string) (err error)

+ func (c *RESTClient) DataviewExists(entity, sampler, name string) (bool, error)

+ func (c *RESTClient) DeleteDataview(entity, sampler, name string) (err error)

+ func (c *RESTClient) DeleteRow(entity, sampler, view, name string) (err error)

+ func (c *RESTClient) Healthy() bool

+ func (c *RESTClient) UpdateDataview(entity, sampler, name string, values [][]string) (err error)

+ func (c *RESTClient) UpdateRow(entity, sampler, view, name string, values []string) (err error)

+ func (c *RESTClient) UpdateStream(entity, sampler, name, message string) (err error)

+ type XMLRPCClient struct

+ func (c *XMLRPCClient) AddHeadline(entity, sampler, view, headline string) error

+ func (c *XMLRPCClient) AddMessage(entity, sampler, stream, message string) error

+ func (c *XMLRPCClient) AddTableColumn(entity, sampler, view, column string) error

+ func (c *XMLRPCClient) AddTableRow(entity, sampler, view, row string) error

+ func (c *XMLRPCClient) ColumnExists(entity, sampler, view, column string) (exists bool, err error)

+ func (c *XMLRPCClient) CreateDataview(entity, sampler, name string) error

+ func (c *XMLRPCClient) CreateRow(entity, sampler, view, name string) (err error)

+ func (c *XMLRPCClient) CreateStream(entity, sampler, name string) (err error)

+ func (c *XMLRPCClient) CreateView(entity, sampler, viewName, groupHeading string) (err error)

+ func (c *XMLRPCClient) DataviewExists(entity, sampler, name string) (bool, error)

+ func (c *XMLRPCClient) DeleteDataview(entity, sampler, name string) error

+ func (c *XMLRPCClient) DeleteRow(entity, sampler, view, name string) (err error)

+ func (c *XMLRPCClient) GatewayConnected() (connected bool, err error)

+ func (c *XMLRPCClient) GetColumnCount(entity, sampler, view string) (count int, err error)

+ func (c *XMLRPCClient) GetColumnNames(entity, sampler, view string) (names []string, err error)

+ func (c *XMLRPCClient) GetHeadlineCount(entity, sampler, view string) (count int, err error)

+ func (c *XMLRPCClient) GetHeadlineNames(entity, sampler, view string) (names []string, err error)

+ func (c *XMLRPCClient) GetParameter(entity, sampler, parameter string) (param string, err error)

+ func (c *XMLRPCClient) GetRowCount(entity, sampler, view string) (count int, err error)

+ func (c *XMLRPCClient) GetRowNames(entity, sampler, view string) (names []string, err error)

+ func (c *XMLRPCClient) GetRowNamesOlderThan(entity, sampler, view string, unixtime int64) (names []string, err error)

+ func (c *XMLRPCClient) HeadlineExists(entity, sampler, view, headline string) (exists bool, err error)

+ func (c *XMLRPCClient) Healthy() bool

+ func (c *XMLRPCClient) Heartbeat(entity string, sampler string) (err error)

+ func (c *XMLRPCClient) HeartbeatStream(entity, sampler, stream string) (err error)

+ func (c *XMLRPCClient) ManagedEntityExists(entity string) (exists bool, err error)

+ func (c *XMLRPCClient) RemoveHeadline(entity, sampler, view, headline string) error

+ func (c *XMLRPCClient) RemoveTableRow(entity, sampler, view, row string) error

+ func (c *XMLRPCClient) RemoveView(entity, sampler, viewName, groupHeading string) error

+ func (c *XMLRPCClient) RowExists(entity, sampler, view, row string) (exists bool, err error)

+ func (c *XMLRPCClient) SamplerExists(entity, sampler string) (exists bool, err error)

+ func (c *XMLRPCClient) SignOff(entity string, sampler string) (err error)

+ func (c *XMLRPCClient) SignOffStream(entity, sampler, stream string) (err error)

+ func (c *XMLRPCClient) SignOn(entity, sampler string, seconds int) (err error)

+ func (c *XMLRPCClient) SignOnStream(entity, sampler, stream string, seconds int) (err error)

+ func (c *XMLRPCClient) UpdateDataview(entity, sampler, name string, values [][]string) error

+ func (c *XMLRPCClient) UpdateEntireTable(entity, sampler, view string, values [][]string) error

+ func (c *XMLRPCClient) UpdateHeadline(entity, sampler, view, headline, value string) error

+ func (c *XMLRPCClient) UpdateRow(entity, sampler, view, name string, values []string) (err error)

+ func (c *XMLRPCClient) UpdateStream(entity, sampler, name, message string) (err error)

+ func (c *XMLRPCClient) UpdateTableCell(entity, sampler, view, cell, value string) error

+ func (c *XMLRPCClient) UpdateTableRow(entity, sampler, view, row string, values []string) error

+ func (c *XMLRPCClient) UpdateVariable(entity, sampler, view, variable, value string) error

+ func (c *XMLRPCClient) ViewExists(entity, sampler, viewName string) (exists bool, err error)

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