Documentation
¶
Index ¶
- type Client
- func (c *Client) Actions(arg params.Entities) (params.ActionResults, error)
- func (c *Client) ApplicationCharmActions(arg params.Entity) (map[string]params.ActionSpec, error)
- func (c *Client) Cancel(arg params.Actions) (params.ActionResults, error)
- func (c *Client) Enqueue(arg params.Actions) (params.ActionResults, error)
- func (c *Client) FindActionTagsByPrefix(arg params.FindTags) (params.FindTagsResults, error)
- func (c *Client) FindActionsByNames(arg params.FindActionsByNames) (params.ActionsByNames, error)
- func (c *Client) ListAll(arg params.Entities) (params.ActionsByReceivers, error)
- func (c *Client) ListCompleted(arg params.Entities) (params.ActionsByReceivers, error)
- func (c *Client) ListPending(arg params.Entities) (params.ActionsByReceivers, error)
- func (c *Client) Run(run params.RunParams) ([]params.ActionResult, error)
- func (c *Client) RunOnAllMachines(commands string, timeout time.Duration) ([]params.ActionResult, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
base.ClientFacade
// contains filtered or unexported fields
}
Client provides access to the action facade.
func NewClient ¶
func NewClient(st base.APICallCloser) *Client
NewClient returns a new actions client.
func (*Client) Actions ¶
Actions takes a list of ActionTags, and returns the full Action for each ID.
func (*Client) ApplicationCharmActions ¶
ApplicationCharmActions is a single query which uses ApplicationsCharmsActions to get the charm.Actions for a single Service by tag.
func (*Client) Enqueue ¶
Enqueue takes a list of Actions and queues them up to be executed by the designated ActionReceiver, returning the params.Action for each queued Action, or an error if there was a problem queueing up the Action.
func (*Client) FindActionTagsByPrefix ¶
FindActionTagsByPrefix takes a list of string prefixes and finds corresponding ActionTags that match that prefix.
func (*Client) FindActionsByNames ¶
func (c *Client) FindActionsByNames(arg params.FindActionsByNames) (params.ActionsByNames, error)
FindActionsByNames takes a list of action names and returns actions for every name.
func (*Client) ListAll ¶
ListAll takes a list of Entities representing ActionReceivers and returns all of the Actions that have been queued or run by each of those Entities.
func (*Client) ListCompleted ¶
ListCompleted takes a list of Entities representing ActionReceivers and returns all of the Actions that have been run on each of those Entities.
func (*Client) ListPending ¶
ListPending takes a list of Entities representing ActionReceivers and returns all of the Actions that are queued for each of those Entities.
func (*Client) Run ¶
Run the Commands specified on the machines identified through the ids provided in the machines, services and units slices.
func (*Client) RunOnAllMachines ¶
func (c *Client) RunOnAllMachines(commands string, timeout time.Duration) ([]params.ActionResult, error)
RunOnAllMachines runs the command on all the machines with the specified timeout.
Source Files