annotations

Documentation

Index

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

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

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, options ...Option) *Client

NewClient creates a new client for accessing the annotations API.

func (*Client) Get

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

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

func (*Client) Set

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

Set sets entity annotation pairs.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.