Class default

APIv7 provides the Action API facade for version 7.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

actions applicationsCharmsActions cancel enqueueOperation listOperations operations run runOnAllMachines watchActionsProgress

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/action/ActionV7.ts:149

Properties

NAME

NAME: string = "Action"

VERSION

VERSION: number = 7

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Action"

`Static` VERSION

VERSION: number = 7

Methods

actions

actions(params: Entities): Promise<ActionResults>
Actions takes a list of ActionTags, and returns the full Action for each ID.
Parameters
- params: Entities
Returns Promise<ActionResults>
- Defined in api/facades/action/ActionV7.ts:160

applicationsCharmsActions

applicationsCharmsActions(params: Entities): Promise<ApplicationsCharmActionsResults>
ApplicationsCharmsActions returns a slice of charm Actions for a slice of services.
Parameters
- params: Entities
Returns Promise<ApplicationsCharmActionsResults>
- Defined in api/facades/action/ActionV7.ts:177

cancel

cancel(params: Entities): Promise<ActionResults>
Cancel attempts to cancel enqueued Actions from running.
Parameters
- params: Entities
Returns Promise<ActionResults>
- Defined in api/facades/action/ActionV7.ts:195

enqueueOperation

enqueueOperation(params: Actions): Promise<EnqueuedActions>
EnqueueOperation takes a list of Actions and queues them up to be executed as an operation, each action running as a task on the designated ActionReceiver. We return the ID of the overall operation and each individual task.
Parameters
- params: Actions
Returns Promise<EnqueuedActions>
- Defined in api/facades/action/ActionV7.ts:213

listOperations

listOperations(params: OperationQueryArgs): Promise<OperationResults>
ListOperations fetches the called actions for specified apps/units.
Parameters
- params: OperationQueryArgs
Returns Promise<OperationResults>
- Defined in api/facades/action/ActionV7.ts:229

operations

operations(params: Entities): Promise<OperationResults>
Operations fetches the specified operation ids.
Parameters
- params: Entities
Returns Promise<OperationResults>
- Defined in api/facades/action/ActionV7.ts:245

run

run(params: RunParams): Promise<EnqueuedActions>
Run the commands specified on the machines identified through the list of machines, units and services.
Parameters
- params: RunParams
Returns Promise<EnqueuedActions>
- Defined in api/facades/action/ActionV7.ts:262

runOnAllMachines

runOnAllMachines(params: RunParams): Promise<EnqueuedActions>
RunOnAllMachines attempts to run the specified command on all the machines.
Parameters
- params: RunParams
Returns Promise<EnqueuedActions>
- Defined in api/facades/action/ActionV7.ts:278

watchActionsProgress

watchActionsProgress(params: Entities): Promise<StringsWatchResults>
WatchActionsProgress creates a watcher that reports on action log messages.
Parameters
- params: Entities
Returns Promise<StringsWatchResults>
- Defined in api/facades/action/ActionV7.ts:294

Generated using TypeDoc