annotations

Documentation

Index

• func Register(registry facade.FacadeRegistry)
• type API
  • func (api *API) Get(ctx context.Context, args params.Entities) params.AnnotationsGetResults
  • func (api *API) Set(ctx context.Context, args params.AnnotationsSet) params.ErrorResults
• type AnnotationService

Functions

func Register

func Register(registry facade.FacadeRegistry)

Register is called to expose a package of facades onto a given registry.

Types

type API

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

API implements the service interface and is the concrete implementation of the api end point.

func (*API) Get

func (api *API) Get(ctx context.Context, args params.Entities) params.AnnotationsGetResults

Get returns annotations for given entities. If annotations cannot be retrieved for a given entity, an error is returned. Each entity is treated independently and, hence, will fail or succeed independently.

func (*API) Set

func (api *API) Set(ctx context.Context, args params.AnnotationsSet) params.ErrorResults

Set stores annotations for given entities

type AnnotationService

type AnnotationService interface {
	// GetCharmAnnotations returns the annotations for the given ID.
	GetAnnotations(context.Context, annotations.ID) (map[string]string, error)

	// GetCharmAnnotations returns the annotations for the given ID.
	GetCharmAnnotations(context.Context, annotation.GetCharmArgs) (map[string]string, error)

	// SetAnnotations sets the annotations for the given ID.
	SetAnnotations(context.Context, annotations.ID, map[string]string) error

	// SetCharmAnnotations sets the annotations for the given ID.
	SetCharmAnnotations(context.Context, annotation.GetCharmArgs, map[string]string) error
}

AnnotationService defines the methods on the annotation service API end point.