annotations

Documentation

Index

• type Client
  • func NewClient(st base.APICallCloser) *Client
  • func (c *Client) Get(tags []string) ([]params.AnnotationsGetResult, error)
  • func (c *Client) Set(annotations map[string]map[string]string) ([]params.ErrorResult, error)

Types

type Client

type Client struct {
	base.ClientFacade
	// contains filtered or unexported fields
}

Client allows access to the annotations API end point.

func NewClient

func NewClient(st base.APICallCloser) *Client

NewClient creates a new client for accessing the annotations API.

func (*Client) Get

func (c *Client) Get(tags []string) ([]params.AnnotationsGetResult, error)

Get returns annotations that have been set on the given entities.

func (*Client) Set

func (c *Client) Set(annotations map[string]map[string]string) ([]params.ErrorResult, error)

Set sets entity annotation pairs.