endpointrelation

Documentation

Index

• Constants
• type Service
  • func NewService(connection portainer.Connection) (*Service, error)
  • func (service *Service) BucketName() string
  • func (service *Service) Create(endpointRelation *portainer.EndpointRelation) error
  • func (service *Service) DeleteEndpointRelation(endpointID portainer.EndpointID) error
  • func (service *Service) EndpointRelation(endpointID portainer.EndpointID) (*portainer.EndpointRelation, error)
  • func (service *Service) EndpointRelations() ([]portainer.EndpointRelation, error)
  • func (service *Service) InvalidateEdgeCacheForEdgeStack(edgeStackID portainer.EdgeStackID)
  • func (service *Service) RegisterUpdateStackFunction(...)
  • func (service *Service) UpdateEndpointRelation(endpointID portainer.EndpointID, endpointRelation *portainer.EndpointRelation) error
  • func (service *Service) UpdateEndpointRelationFunc(endpointID portainer.EndpointID, ...) error

Constants

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

Types

type Service

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

Service represents a service for managing environment(endpoint) relation 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(endpointRelation *portainer.EndpointRelation) error

CreateEndpointRelation saves endpointRelation

func (*Service) DeleteEndpointRelation

func (service *Service) DeleteEndpointRelation(endpointID portainer.EndpointID) error

DeleteEndpointRelation deletes an Environment(Endpoint) relation object

func (*Service) EndpointRelation

func (service *Service) EndpointRelation(endpointID portainer.EndpointID) (*portainer.EndpointRelation, error)

EndpointRelation returns a Environment(Endpoint) relation object by EndpointID

func (*Service) EndpointRelations

func (service *Service) EndpointRelations() ([]portainer.EndpointRelation, error)

EndpointRelations returns an array of all EndpointRelations

func (*Service) InvalidateEdgeCacheForEdgeStack

func (service *Service) InvalidateEdgeCacheForEdgeStack(edgeStackID portainer.EdgeStackID)

func (*Service) RegisterUpdateStackFunction

func (service *Service) RegisterUpdateStackFunction(updateFunc func(ID portainer.EdgeStackID, updateFunc func(edgeStack *portainer.EdgeStack)) error)

func (*Service) UpdateEndpointRelation

func (service *Service) UpdateEndpointRelation(endpointID portainer.EndpointID, endpointRelation *portainer.EndpointRelation) error

Deprecated: Use UpdateEndpointRelationFunc instead.

func (*Service) UpdateEndpointRelationFunc

func (service *Service) UpdateEndpointRelationFunc(endpointID portainer.EndpointID, updateFunc func(endpointRelation *portainer.EndpointRelation)) error

UpdateEndpointRelationFunc updates an Environment(Endpoint) relation object