task

Documentation

Index

• func Wait(ctx context.Context, ref types.ManagedObjectReference, pc *property.Collector, ...) (*types.TaskInfo, error)
• type Error
  • func (e Error) Error() string
  • func (e Error) Fault() types.BaseMethodFault
• type HistoryCollector
  • func (h HistoryCollector) ReadNextTasks(ctx context.Context, maxCount int32) ([]types.TaskInfo, error)
  • func (h HistoryCollector) ReadPreviousTasks(ctx context.Context, maxCount int32) ([]types.TaskInfo, error)
  • func (h HistoryCollector) RecentTasks(ctx context.Context) ([]types.TaskInfo, error)
• type Manager
  • func NewManager(c *vim25.Client) *Manager
  • func (m Manager) CreateCollectorForTasks(ctx context.Context, filter types.TaskFilterSpec) (*HistoryCollector, error)
  • func (m Manager) Reference() types.ManagedObjectReference

Functions

func Wait

func Wait(ctx context.Context, ref types.ManagedObjectReference, pc *property.Collector, s progress.Sinker) (*types.TaskInfo, error)

Wait waits for a task to finish with either success or failure. It does so by waiting for the "info" property of task managed object to change. The function returns when it finds the task in the "success" or "error" state. In the former case, the return value is nil. In the latter case the return value is an instance of this package's Error struct.

Any error returned while waiting for property changes causes the function to return immediately and propagate the error.

If the progress.Sinker argument is specified, any progress updates for the task are sent here. The completion percentage is passed through directly. The detail for the progress update is set to an empty string. If the task finishes in the error state, the error instance is passed through as well. Note that this error is the same error that is returned by this function.

Types

type Error

type Error struct {
	*types.LocalizedMethodFault
	Description *types.LocalizableMessage
}

func (Error) Error

func (e Error) Error() string

Error returns the task's localized fault message.

func (Error) Fault

func (e Error) Fault() types.BaseMethodFault

type HistoryCollector

type HistoryCollector struct {
	*history.Collector
}

HistoryCollector provides a mechanism for retrieving historical data and updates when the server appends new tasks.

func (HistoryCollector) ReadNextTasks

func (h HistoryCollector) ReadNextTasks(ctx context.Context, maxCount int32) ([]types.TaskInfo, error)

ReadNextTasks reads the scrollable view from the current position. The scrollable position is moved to the next newer page after the read. No item is returned when the end of the collector is reached.

func (HistoryCollector) ReadPreviousTasks

func (h HistoryCollector) ReadPreviousTasks(ctx context.Context, maxCount int32) ([]types.TaskInfo, error)

ReadPreviousTasks reads the scrollable view from the current position. The scrollable position is then moved to the next older page after the read. No item is returned when the head of the collector is reached.

func (HistoryCollector) RecentTasks

func (h HistoryCollector) RecentTasks(ctx context.Context) ([]types.TaskInfo, error)

RecentTasks returns a list of task managed objects that completed recently, that are currently running, or that are queued to run.

type Manager

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

func NewManager

func NewManager(c *vim25.Client) *Manager

NewManager creates a new task manager

func (Manager) CreateCollectorForTasks

func (m Manager) CreateCollectorForTasks(ctx context.Context, filter types.TaskFilterSpec) (*HistoryCollector, error)

CreateCollectorForTasks returns a task history collector, a specialized history collector that gathers TaskInfo data objects.

func (Manager) Reference

func (m Manager) Reference() types.ManagedObjectReference

Reference returns the task.Manager MOID