aliases

Documentation

Index

• type Client
  • func New(c HTTPClient) *Client
  • func (c *Client) Create(ctx context.Context, req CreateRequest) error
  • func (c *Client) Delete(ctx context.Context, req DeleteRequest) error
  • func (c *Client) Find(ctx context.Context, req FindRequest) (map[string]interface{}, error)
  • func (c *Client) Index(ctx context.Context) ([]IndexResponse, error)
  • func (c *Client) Update(ctx context.Context, req UpdateRequest) error
• type CreateRequest
• type DeleteRequest
• type FindRequest
• type HTTPClient
• type IndexResponse
• type UpdateRequest

Types

type Client

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

func New

func New(c HTTPClient) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, req CreateRequest) error

Create Create IP or Network Alias.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, req DeleteRequest) error

Delete Remove IP or Network alias.

func (*Client) Find

func (c *Client) Find(ctx context.Context, req FindRequest) (map[string]interface{}, error)

Find Read alias.

func (*Client) Index

func (c *Client) Index(ctx context.Context) ([]IndexResponse, error)

Index List aliases

func (*Client) Update

func (c *Client) Update(ctx context.Context, req UpdateRequest) error

Update Update IP or Network alias.

type CreateRequest

type CreateRequest struct {
	Cidr string `url:"cidr" json:"cidr"` // Network/IP specification in CIDR format.
	Name string `url:"name" json:"name"` // Alias name.

	// The following parameters are optional
	Comment *string `url:"comment,omitempty" json:"comment,omitempty"`
}

type DeleteRequest

type DeleteRequest struct {
	Name string `url:"name" json:"name"` // Alias name.

	// The following parameters are optional
	Digest *string `url:"digest,omitempty" json:"digest,omitempty"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
}

type FindRequest

type FindRequest struct {
	Name string `url:"name" json:"name"` // Alias name.

}

type HTTPClient

type HTTPClient interface {
	Do(context.Context, string, string, interface{}, interface{}) error
}

type IndexResponse

type IndexResponse struct {
	Cidr   string `url:"cidr" json:"cidr"`
	Digest string `url:"digest" json:"digest"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	Name   string `url:"name" json:"name"`

	// The following parameters are optional
	Comment *string `url:"comment,omitempty" json:"comment,omitempty"`
}

type UpdateRequest

type UpdateRequest struct {
	Cidr string `url:"cidr" json:"cidr"` // Network/IP specification in CIDR format.
	Name string `url:"name" json:"name"` // Alias name.

	// The following parameters are optional
	Comment *string `url:"comment,omitempty" json:"comment,omitempty"`
	Digest  *string `url:"digest,omitempty" json:"digest,omitempty"` // Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
	Rename  *string `url:"rename,omitempty" json:"rename,omitempty"` // Rename an existing alias.
}