scheduler

Documentation

Overview

Package scheduler provides clients used for integration with the support-scheduler service.

Index

• type IntervalActionClient
  • func NewIntervalActionClient(params types.EndpointParams, m clients.Endpointer) IntervalActionClient
• type IntervalClient
  • func NewIntervalClient(params types.EndpointParams, m clients.Endpointer) IntervalClient

Types

type IntervalActionClient

type IntervalActionClient interface {
	// Add a new schedule interval action
	Add(dev *models.IntervalAction, ctx context.Context) (string, error)
	// Delete a schedule interval action for the specified ID
	Delete(id string, ctx context.Context) error
	// Delete a schedule interval action for the specified name
	DeleteByName(name string, ctx context.Context) error
	// IntervalAction loads a schedule interval action for the specified ID
	IntervalAction(id string, ctx context.Context) (models.IntervalAction, error)
	// IntervalActionForName loads a schedule interval action for the specified name
	IntervalActionForName(name string, ctx context.Context) (models.IntervalAction, error)
	// IntervalActions lists all schedule interval actions
	IntervalActions(ctx context.Context) ([]models.IntervalAction, error)
	// IntervalActionsForTargetByName lists all schedule interval actions that target a particular service
	IntervalActionsForTargetByName(name string, ctx context.Context) ([]models.IntervalAction, error)
	// Update a schedule interval action
	Update(dev models.IntervalAction, ctx context.Context) error
}

IntervalActionClient defines the interface for interactions with the IntervalAction endpoint on the EdgeX Foundry support-scheduler service.

func NewIntervalActionClient

func NewIntervalActionClient(params types.EndpointParams, m clients.Endpointer) IntervalActionClient

NewIntervalActionClient creates an instance of IntervalActionClient

type IntervalClient

type IntervalClient interface {
	// Add a new scheduling interval
	Add(dev *models.Interval, ctx context.Context) (string, error)
	// Delete eliminates a scheduling interval for the specified ID
	Delete(id string, ctx context.Context) error
	// Delete eliminates a scheduling interval for the specified name
	DeleteByName(name string, ctx context.Context) error
	// Interval loads the scheduling interval for the specified ID
	Interval(id string, ctx context.Context) (models.Interval, error)
	// IntervalForName loads the scheduling interval for the specified name
	IntervalForName(name string, ctx context.Context) (models.Interval, error)
	// Intervals lists all scheduling intervals
	Intervals(ctx context.Context) ([]models.Interval, error)
	// Update a scheduling interval
	Update(interval models.Interval, ctx context.Context) error
}

IntervalClient defines the interface for interactions with the Interval endpoint on the EdgeX Foundry support-scheduler service.

func NewIntervalClient

func NewIntervalClient(params types.EndpointParams, m clients.Endpointer) IntervalClient

NewIntervalClient creates an instance of IntervalClient