tag

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(tag *portainer.Tag) error
  • func (service *Service) DeleteTag(ID portainer.TagID) error
  • func (service *Service) Tag(ID portainer.TagID) (*portainer.Tag, error)
  • func (service *Service) Tags() ([]portainer.Tag, error)
  • func (service *Service) UpdateTag(ID portainer.TagID, tag *portainer.Tag) error
  • func (service *Service) UpdateTagFunc(ID portainer.TagID, updateFunc func(tag *portainer.Tag)) error

Constants

const (
	// BucketName represents the name of the bucket where this service stores data.
	BucketName = "tags"
)

Types

type Service

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

Service represents a service for managing environment(endpoint) data.

func NewService

func NewService(connection portainer.Connection) (*Service, error)

NewService creates a new instance of a service.

func (*Service) BucketName

func (service *Service) BucketName() string

func (*Service) Create

func (service *Service) Create(tag *portainer.Tag) error

CreateTag creates a new tag.

func (*Service) DeleteTag

func (service *Service) DeleteTag(ID portainer.TagID) error

DeleteTag deletes a tag.

func (*Service) Tag

func (service *Service) Tag(ID portainer.TagID) (*portainer.Tag, error)

Tag returns a tag by ID.

func (*Service) Tags

func (service *Service) Tags() ([]portainer.Tag, error)

Tags return an array containing all the tags.

func (*Service) UpdateTag

func (service *Service) UpdateTag(ID portainer.TagID, tag *portainer.Tag) error

Deprecated: Use UpdateTagFunc instead.

func (*Service) UpdateTagFunc

func (service *Service) UpdateTagFunc(ID portainer.TagID, updateFunc func(tag *portainer.Tag)) error

UpdateTagFunc updates a tag inside a transaction avoiding data races.