resourcecontrol

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(resourceControl *portainer.ResourceControl) error
  • func (service *Service) DeleteResourceControl(ID portainer.ResourceControlID) error
  • func (service *Service) ResourceControl(ID portainer.ResourceControlID) (*portainer.ResourceControl, error)
  • func (service *Service) ResourceControlByResourceIDAndType(resourceID string, resourceType portainer.ResourceControlType) (*portainer.ResourceControl, error)
  • func (service *Service) ResourceControls() ([]portainer.ResourceControl, error)
  • func (service *Service) UpdateResourceControl(ID portainer.ResourceControlID, resourceControl *portainer.ResourceControl) error

Constants

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

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(resourceControl *portainer.ResourceControl) error

CreateResourceControl creates a new ResourceControl object

func (*Service) DeleteResourceControl

func (service *Service) DeleteResourceControl(ID portainer.ResourceControlID) error

DeleteResourceControl deletes a ResourceControl object by ID

func (*Service) ResourceControl

func (service *Service) ResourceControl(ID portainer.ResourceControlID) (*portainer.ResourceControl, error)

ResourceControl returns a ResourceControl object by ID

func (*Service) ResourceControlByResourceIDAndType

func (service *Service) ResourceControlByResourceIDAndType(resourceID string, resourceType portainer.ResourceControlType) (*portainer.ResourceControl, error)

ResourceControlByResourceIDAndType returns a ResourceControl object by checking if the resourceID is equal to the main ResourceID or in SubResourceIDs. It also performs a check on the resource type. Return nil if no ResourceControl was found.

func (*Service) ResourceControls

func (service *Service) ResourceControls() ([]portainer.ResourceControl, error)

ResourceControls returns all the ResourceControl objects

func (*Service) UpdateResourceControl

func (service *Service) UpdateResourceControl(ID portainer.ResourceControlID, resourceControl *portainer.ResourceControl) error

UpdateResourceControl saves a ResourceControl object.