action

Documentation

Index

• type APIv7
  • func NewActionAPIV7(ctx facade.Context) (*APIv7, error)
• type ActionAPI
  • func (a *ActionAPI) Actions(arg params.Entities) (params.ActionResults, error)
  • func (a *ActionAPI) ApplicationsCharmsActions(args params.Entities) (params.ApplicationsCharmActionsResults, error)
  • func (a *ActionAPI) Cancel(arg params.Entities) (params.ActionResults, error)
  • func (a *ActionAPI) EnqueueOperation(arg params.Actions) (params.EnqueuedActions, error)
  • func (a *ActionAPI) ListOperations(arg params.OperationQueryArgs) (params.OperationResults, error)
  • func (a *ActionAPI) Operations(arg params.Entities) (params.OperationResults, error)
  • func (a *ActionAPI) Run(run params.RunParams) (results params.EnqueuedActions, err error)
  • func (a *ActionAPI) RunOnAllMachines(run params.RunParams) (results params.EnqueuedActions, err error)
  • func (api *ActionAPI) WatchActionsProgress(actions params.Entities) (params.StringsWatchResults, error)

Types

type APIv7

type APIv7 struct {
	*ActionAPI
}

APIv7 provides the Action API facade for version 7.

func NewActionAPIV7

func NewActionAPIV7(ctx facade.Context) (*APIv7, error)

NewActionAPIV7 returns an initialized ActionAPI for version 7.

type ActionAPI

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

ActionAPI implements the client API for interacting with Actions

func (*ActionAPI) Actions

func (a *ActionAPI) Actions(arg params.Entities) (params.ActionResults, error)

Actions takes a list of ActionTags, and returns the full Action for each ID.

func (*ActionAPI) ApplicationsCharmsActions

func (a *ActionAPI) ApplicationsCharmsActions(args params.Entities) (params.ApplicationsCharmActionsResults, error)

ApplicationsCharmsActions returns a slice of charm Actions for a slice of services.

func (*ActionAPI) Cancel

func (a *ActionAPI) Cancel(arg params.Entities) (params.ActionResults, error)

Cancel attempts to cancel enqueued Actions from running.

func (*ActionAPI) EnqueueOperation

func (a *ActionAPI) EnqueueOperation(arg params.Actions) (params.EnqueuedActions, error)

EnqueueOperation takes a list of Actions and queues them up to be executed as an operation, each action running as a task on the the designated ActionReceiver. We return the ID of the overall operation and each individual task.

func (*ActionAPI) ListOperations

func (a *ActionAPI) ListOperations(arg params.OperationQueryArgs) (params.OperationResults, error)

ListOperations fetches the called actions for specified apps/units.

func (*ActionAPI) Operations

func (a *ActionAPI) Operations(arg params.Entities) (params.OperationResults, error)

Operations fetches the specified operation ids.

func (*ActionAPI) Run

func (a *ActionAPI) Run(run params.RunParams) (results params.EnqueuedActions, err error)

Run the commands specified on the machines identified through the list of machines, units and services.

func (*ActionAPI) RunOnAllMachines

func (a *ActionAPI) RunOnAllMachines(run params.RunParams) (results params.EnqueuedActions, err error)

RunOnAllMachines attempts to run the specified command on all the machines.

func (*ActionAPI) WatchActionsProgress

func (api *ActionAPI) WatchActionsProgress(actions params.Entities) (params.StringsWatchResults, error)

WatchActionsProgress creates a watcher that reports on action log messages.