juju: github.com/juju/juju/apiserver/facades/client/action Index | Files

package action

import "github.com/juju/juju/apiserver/facades/client/action"

Index

Package Files

action.go legacy.go operation.go run.go

type APIv2 Uses

type APIv2 struct {
    *APIv3
}

APIv2 provides the Action API facade for version 2.

func NewActionAPIV2 Uses

func NewActionAPIV2(ctx facade.Context) (*APIv2, error)

NewActionAPIV2 returns an initialized ActionAPI for version 2.

type APIv3 Uses

type APIv3 struct {
    *APIv4
}

APIv3 provides the Action API facade for version 3.

func NewActionAPIV3 Uses

func NewActionAPIV3(ctx facade.Context) (*APIv3, error)

NewActionAPIV3 returns an initialized ActionAPI for version 3.

type APIv4 Uses

type APIv4 struct {
    *APIv5
}

APIv4 provides the Action API facade for version 4.

func NewActionAPIV4 Uses

func NewActionAPIV4(ctx facade.Context) (*APIv4, error)

NewActionAPIV4 returns an initialized ActionAPI for version 4.

func (*APIv4) Actions Uses

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

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

func (*APIv4) Cancel Uses

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

Cancel attempts to cancel enqueued Actions from running.

func (*APIv4) ListAll Uses

func (a *APIv4) 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 (*APIv4) ListCompleted Uses

func (a *APIv4) 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.

type APIv5 Uses

type APIv5 struct {
    *APIv6
}

APIv5 provides the Action API facade for version 5.

func NewActionAPIV5 Uses

func NewActionAPIV5(ctx facade.Context) (*APIv5, error)

NewActionAPIV5 returns an initialized ActionAPI for version 5.

func (*APIv5) EnqueueOperation Uses

func (*APIv5) EnqueueOperation(_, _ struct{})

EnqueueOperation isn't on the V5 API.

type APIv6 Uses

type APIv6 struct {
    *ActionAPI
}

APIv6 provides the Action API facade for version 6.

func NewActionAPIV6 Uses

func NewActionAPIV6(ctx facade.Context) (*APIv6, error)

NewActionAPIV6 returns an initialized ActionAPI for version 6.

type ActionAPI Uses

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

ActionAPI implements the client API for interacting with Actions

func (*ActionAPI) Actions Uses

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 Uses

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 Uses

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

Cancel attempts to cancel enqueued Actions from running.

func (*ActionAPI) Enqueue Uses

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) EnqueueOperation Uses

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) FindActionTagsByPrefix Uses

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. TODO(juju3) - rename API method since we only need prefix matching for UUIDs

func (*ActionAPI) FindActionsByNames Uses

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

func (*ActionAPI) ListAll Uses

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 Uses

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) ListOperations Uses

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

ListOperations fetches the called actions for specified apps/units.

func (*ActionAPI) ListPending Uses

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 Uses

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) Operations Uses

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

Operations fetches the specified operation ids.

func (*ActionAPI) Run Uses

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 Uses

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

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

func (*ActionAPI) WatchActionsProgress Uses

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

WatchActionsProgress creates a watcher that reports on action log messages.

Package action imports 14 packages (graph) and is imported by 4 packages. Updated 2020-07-22. Refresh now. Tools for package owners.