settings

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) IsFeatureFlagEnabled(feature portainer.Feature) bool
  • func (service *Service) Settings() (*portainer.Settings, error)
  • func (service *Service) UpdateSettings(settings *portainer.Settings) error

Constants

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

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) IsFeatureFlagEnabled

func (service *Service) IsFeatureFlagEnabled(feature portainer.Feature) bool

func (*Service) Settings

func (service *Service) Settings() (*portainer.Settings, error)

Settings retrieve the settings object.

func (*Service) UpdateSettings

func (service *Service) UpdateSettings(settings *portainer.Settings) error

UpdateSettings persists a Settings object.