endpointgroup

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(endpointGroup *portainer.EndpointGroup) error
  • func (service *Service) DeleteEndpointGroup(ID portainer.EndpointGroupID) error
  • func (service *Service) EndpointGroup(ID portainer.EndpointGroupID) (*portainer.EndpointGroup, error)
  • func (service *Service) EndpointGroups() ([]portainer.EndpointGroup, error)
  • func (service *Service) UpdateEndpointGroup(ID portainer.EndpointGroupID, endpointGroup *portainer.EndpointGroup) error

Constants

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

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(endpointGroup *portainer.EndpointGroup) error

CreateEndpointGroup assign an ID to a new environment(endpoint) group and saves it.

func (*Service) DeleteEndpointGroup

func (service *Service) DeleteEndpointGroup(ID portainer.EndpointGroupID) error

DeleteEndpointGroup deletes an environment(endpoint) group.

func (*Service) EndpointGroup

func (service *Service) EndpointGroup(ID portainer.EndpointGroupID) (*portainer.EndpointGroup, error)

EndpointGroup returns an environment(endpoint) group by ID.

func (*Service) EndpointGroups

func (service *Service) EndpointGroups() ([]portainer.EndpointGroup, error)

EndpointGroups return an array containing all the environment(endpoint) groups.

func (*Service) UpdateEndpointGroup

func (service *Service) UpdateEndpointGroup(ID portainer.EndpointGroupID, endpointGroup *portainer.EndpointGroup) error

UpdateEndpointGroup updates an environment(endpoint) group.