api

Documentation

Index

• Variables
• func Add[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K) (string, error)
• func Delete(c *Client, ctx context.Context, opts ReqOpts, id string) error
• func Get[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, id string) (*K, error)
• func GetAll[K any](c *Client, ctx context.Context, opts ReqOpts, resources []K) ([]K, error)
• func GetFilter[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, key string) (*K, error)
• func Update[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, id string) error
• type Client
  • func NewClient(options Options) *Client
  • func (c *Client) ReconfigureService(ctx context.Context, endpoint string) error
• type Options
• type ReqOpts
• type SelectedMap
  • func (s *SelectedMap) String() string
  • func (s *SelectedMap) UnmarshalJSON(data []byte) error
• type SelectedMapList
  • func (s *SelectedMapList) MarshalJSON() ([]byte, error)
  • func (s *SelectedMapList) String() string
  • func (s *SelectedMapList) UnmarshalJSON(data []byte) error
• type SelectedMapListNL
  • func (s *SelectedMapListNL) MarshalJSON() ([]byte, error)
  • func (s *SelectedMapListNL) String() string
  • func (s *SelectedMapListNL) UnmarshalJSON(data []byte) error

Variables

var GlobalMutexKV = newMutexKV()

GlobalMutexKV is a global MutexKV for use within this plugin.

Functions

func Add

func Add[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K) (string, error)

func Delete

func Delete(c *Client, ctx context.Context, opts ReqOpts, id string) error

func Get

func Get[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, id string) (*K, error)

func GetAll

func GetAll[K any](c *Client, ctx context.Context, opts ReqOpts, resources []K) ([]K, error)

func GetFilter

func GetFilter[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, key string) (*K, error)

func Update

func Update[K any](c *Client, ctx context.Context, opts ReqOpts, resource *K, id string) error

Types

type Client

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

func NewClient

func NewClient(options Options) *Client

func (*Client) ReconfigureService

func (c *Client) ReconfigureService(ctx context.Context, endpoint string) error

ReconfigureService defined at the endpoint.

type Options

type Options struct {
	Uri           string
	APIKey        string
	APISecret     string
	AllowInsecure bool

	// Retries
	MaxBackoff int64
	MinBackoff int64
	MaxRetries int64
}

type ReqOpts

type ReqOpts struct {
	AddEndpoint         string
	GetEndpoint         string
	UpdateEndpoint      string
	DeleteEndpoint      string
	ReconfigureEndpoint string

	Monad string
}

type SelectedMap

type SelectedMap string

func (*SelectedMap) String

func (s *SelectedMap) String() string

func (*SelectedMap) UnmarshalJSON

func (s *SelectedMap) UnmarshalJSON(data []byte) error

type SelectedMapList

type SelectedMapList []string

func (*SelectedMapList) MarshalJSON

func (s *SelectedMapList) MarshalJSON() ([]byte, error)

func (*SelectedMapList) String

func (s *SelectedMapList) String() string

func (*SelectedMapList) UnmarshalJSON

func (s *SelectedMapList) UnmarshalJSON(data []byte) error

type SelectedMapListNL

type SelectedMapListNL []string

func (*SelectedMapListNL) MarshalJSON

func (s *SelectedMapListNL) MarshalJSON() ([]byte, error)

func (*SelectedMapListNL) String

func (s *SelectedMapListNL) String() string

func (*SelectedMapListNL) UnmarshalJSON

func (s *SelectedMapListNL) UnmarshalJSON(data []byte) error