edgegroup

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(group *portainer.EdgeGroup) error
  • func (service *Service) DeleteEdgeGroup(ID portainer.EdgeGroupID) error
  • func (service *Service) EdgeGroup(ID portainer.EdgeGroupID) (*portainer.EdgeGroup, error)
  • func (service *Service) EdgeGroups() ([]portainer.EdgeGroup, error)
  • func (service *Service) UpdateEdgeGroup(ID portainer.EdgeGroupID, group *portainer.EdgeGroup) error
  • func (service *Service) UpdateEdgeGroupFunc(ID portainer.EdgeGroupID, updateFunc func(edgeGroup *portainer.EdgeGroup)) error

Constants

const BucketName = "edgegroups"

BucketName represents the name of the bucket where this service stores data.

Types

type Service

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

Service represents a service for managing Edge group 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(group *portainer.EdgeGroup) error

CreateEdgeGroup assign an ID to a new Edge group and saves it.

func (*Service) DeleteEdgeGroup

func (service *Service) DeleteEdgeGroup(ID portainer.EdgeGroupID) error

DeleteEdgeGroup deletes an Edge group.

func (*Service) EdgeGroup

func (service *Service) EdgeGroup(ID portainer.EdgeGroupID) (*portainer.EdgeGroup, error)

EdgeGroup returns an Edge group by ID.

func (*Service) EdgeGroups

func (service *Service) EdgeGroups() ([]portainer.EdgeGroup, error)

EdgeGroups return an array containing all the Edge groups.

func (*Service) UpdateEdgeGroup

func (service *Service) UpdateEdgeGroup(ID portainer.EdgeGroupID, group *portainer.EdgeGroup) error

Deprecated: Use UpdateEdgeGroupFunc instead.

func (*Service) UpdateEdgeGroupFunc

func (service *Service) UpdateEdgeGroupFunc(ID portainer.EdgeGroupID, updateFunc func(edgeGroup *portainer.EdgeGroup)) error

UpdateEdgeGroupFunc updates an edge group inside a transaction avoiding data races.