machineundertaker

Documentation

Index

• Variables
• type API
  • func NewAPI(caller base.APICaller, newWatcher NewWatcherFunc, options ...Option) (*API, error)
  • func (api *API) AllMachineRemovals(ctx context.Context) ([]names.MachineTag, error)
  • func (api *API) CompleteRemoval(ctx context.Context, machine names.MachineTag) error
  • func (api *API) GetProviderInterfaceInfo(ctx context.Context, machine names.MachineTag) ([]network.ProviderInterfaceInfo, error)
  • func (api *API) WatchMachineRemovals(ctx context.Context) (watcher.NotifyWatcher, error)
• type NewWatcherFunc
• type Option

Variables

var WithTracer = base.WithTracer

WithTracer returns an Option that configures the Client to use the supplied tracer.

Types

type API

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

API provides access to the machine undertaker API facade.

func NewAPI

func NewAPI(caller base.APICaller, newWatcher NewWatcherFunc, options ...Option) (*API, error)

NewAPI creates a new client-side machine undertaker facade.

func (*API) AllMachineRemovals

func (api *API) AllMachineRemovals(ctx context.Context) ([]names.MachineTag, error)

AllMachineRemovals returns all the machines that have been marked ready to clean up.

func (*API) CompleteRemoval

func (api *API) CompleteRemoval(ctx context.Context, machine names.MachineTag) error

CompleteRemoval finishes the removal of the machine in the database after any provider resources are cleaned up.

func (*API) GetProviderInterfaceInfo

func (api *API) GetProviderInterfaceInfo(ctx context.Context, machine names.MachineTag) ([]network.ProviderInterfaceInfo, error)

GetProviderInterfaceInfo gets the provider details for all of the interfaces for one machine.

func (*API) WatchMachineRemovals

func (api *API) WatchMachineRemovals(ctx context.Context) (watcher.NotifyWatcher, error)

WatchMachineRemovals registers to be notified when a machine removal is requested.

type NewWatcherFunc

type NewWatcherFunc func(base.APICaller, params.NotifyWatchResult) watcher.NotifyWatcher

NewWatcherFunc exists to let us test WatchMachineRemovals.

type Option

type Option = base.Option

Option is a function that can be used to configure a Client.