client

Documentation

Index

• func New(conf Config) (api.RulesService, error)
• type Client
  • func NewClient(conf Config) (*Client, error)
  • func (c *Client) CreateRules(rulesSet *api.RulesSet) (*api.RulesIDList, error)
  • func (c *Client) Debug(debug bool)
  • func (c *Client) DeleteRules(filter *api.RuleFilter) error
  • func (c *Client) ListAction(filter *api.RuleFilter) (*api.RulesByService, error)
  • func (c *Client) ListRoutes(filter *api.RuleFilter) (*api.RulesByService, error)
  • func (c *Client) ListRules(filter *api.RuleFilter) (*api.RulesSet, error)
  • func (c *Client) UpdateRules(rulesSet *api.RulesSet) (*api.RulesIDList, error)
• type Config

Functions

func New

func New(conf Config) (api.RulesService, error)

New constructs a new A8 controller client.

Types

type Client

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

Client implements the Amalgam8 Controller API

func NewClient

func NewClient(conf Config) (*Client, error)

NewClient constructs a new A8 API controller client. It returns the Client structure

func (*Client) CreateRules

func (c *Client) CreateRules(rulesSet *api.RulesSet) (*api.RulesIDList, error)

CreateRules creates the rules

func (*Client) Debug

func (c *Client) Debug(debug bool)

Debug is used to set the debugging flag.

func (*Client) DeleteRules

func (c *Client) DeleteRules(filter *api.RuleFilter) error

DeleteRules deletes the rules

func (*Client) ListAction

func (c *Client) ListAction(filter *api.RuleFilter) (*api.RulesByService, error)

ListAction retuns the list of action rules

func (*Client) ListRoutes

func (c *Client) ListRoutes(filter *api.RuleFilter) (*api.RulesByService, error)

ListRoutes return sthe list of route rules

func (*Client) ListRules

func (c *Client) ListRules(filter *api.RuleFilter) (*api.RulesSet, error)

ListRules returns the list of rules

func (*Client) UpdateRules

func (c *Client) UpdateRules(rulesSet *api.RulesSet) (*api.RulesIDList, error)

UpdateRules updates the rules

type Config

type Config struct {

	// URL of the controller server.
	URL string

	// AuthToken is the token to be used for authentication with the controller.
	// If left empty, no authentication is used.
	AuthToken string

	// HTTPClient can be used to customize the underlying HTTP client behavior,
	// such as enabling TLS, setting timeouts, etc.
	// If left nil, a default HTTP client will be used.
	HTTPClient *http.Client
}

Config stores the configurable attributes of the client.