action

Documentation

Index

• type ActionAPI
  • func NewActionAPI(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (*ActionAPI, error)
  • 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) Enqueue(arg params.Actions) (params.ActionResults, error)
  • func (a *ActionAPI) FindActionTagsByPrefix(arg params.FindTags) (params.FindTagsResults, error)
  • func (a *ActionAPI) FindActionsByNames(arg params.FindActionsByNames) (params.ActionsByNames, error)
  • func (a *ActionAPI) ListAll(arg params.Entities) (params.ActionsByReceivers, error)
  • func (a *ActionAPI) ListCompleted(arg params.Entities) (params.ActionsByReceivers, error)
  • func (a *ActionAPI) ListPending(arg params.Entities) (params.ActionsByReceivers, error)
  • func (a *ActionAPI) ListRunning(arg params.Entities) (params.ActionsByReceivers, error)
  • func (a *ActionAPI) Run(run params.RunParams) (results params.ActionResults, err error)
  • func (a *ActionAPI) RunOnAllMachines(run params.RunParams) (results params.ActionResults, err error)

Types

type ActionAPI

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

ActionAPI implements the client API for interacting with Actions

func NewActionAPI

func NewActionAPI(st *state.State, resources facade.Resources, authorizer facade.Authorizer) (*ActionAPI, error)

NewActionAPI returns an initialized ActionAPI

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) Enqueue

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

Enqueue takes a list of Actions and queues them up to be executed by the designated ActionReceiver, returning the params.Action for each enqueued Action, or an error if there was a problem enqueueing the Action.

func (*ActionAPI) FindActionTagsByPrefix

func (a *ActionAPI) FindActionTagsByPrefix(arg params.FindTags) (params.FindTagsResults, error)

FindActionTagsByPrefix takes a list of string prefixes and finds corresponding ActionTags that match that prefix.

func (*ActionAPI) FindActionsByNames

func (a *ActionAPI) FindActionsByNames(arg params.FindActionsByNames) (params.ActionsByNames, error)

func (*ActionAPI) ListAll

func (a *ActionAPI) ListAll(arg params.Entities) (params.ActionsByReceivers, error)

ListAll takes a list of Entities representing ActionReceivers and returns all of the Actions that have been enqueued or run by each of those Entities.

func (*ActionAPI) ListCompleted

func (a *ActionAPI) ListCompleted(arg params.Entities) (params.ActionsByReceivers, error)

ListCompleted takes a list of Entities representing ActionReceivers and returns all of the Actions that have been run on each of those Entities.

func (*ActionAPI) ListPending

func (a *ActionAPI) ListPending(arg params.Entities) (params.ActionsByReceivers, error)

ListPending takes a list of Entities representing ActionReceivers and returns all of the Actions that are enqueued for each of those Entities.

func (*ActionAPI) ListRunning

func (a *ActionAPI) ListRunning(arg params.Entities) (params.ActionsByReceivers, error)

ListRunning takes a list of Entities representing ActionReceivers and returns all of the Actions that have are running on each of those Entities.

func (*ActionAPI) Run

func (a *ActionAPI) Run(run params.RunParams) (results params.ActionResults, 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.ActionResults, err error)

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