Class default

AgentAPI implements the version 3 of the API provided to an agent.

Hierarchy

default

Implements

Facade

Index

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/agent/AgentV3.ts:151

Properties

NAME

NAME: string = "Agent"

VERSION

VERSION: number = 3

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "Agent"

`Static` VERSION

VERSION: number = 3

Methods

clearReboot

clearReboot(params: Entities): Promise<ErrorResults>
ClearReboot will clear the reboot flag on provided machines, if it exists.
Parameters
- params: Entities
Returns Promise<ErrorResults>
- Defined in api/facades/agent/AgentV3.ts:161

cloudSpec

cloudSpec(params: Entities): Promise<CloudSpecResults>
CloudSpec returns the model's cloud spec.
Parameters
- params: Entities
Returns Promise<CloudSpecResults>
- Defined in api/facades/agent/AgentV3.ts:177

controllerAPIInfoForModels

controllerAPIInfoForModels(params: Entities): Promise<ControllerAPIInfoResults>
ControllerAPIInfoForModels returns the controller api connection details for the specified models.
Parameters
- params: Entities
Returns Promise<ControllerAPIInfoResults>
- Defined in api/facades/agent/AgentV3.ts:193

controllerConfig

controllerConfig(params: any): Promise<ControllerConfigResult>
ControllerConfig returns the controller's configuration.
Parameters
- params: any
Returns Promise<ControllerConfigResult>
- Defined in api/facades/agent/AgentV3.ts:211

getCloudSpec

getCloudSpec(params: ModelTag): Promise<CloudSpecResult>
GetCloudSpec constructs the CloudSpec for a validated and authorized model.
Parameters
- params: ModelTag
Returns Promise<CloudSpecResult>
- Defined in api/facades/agent/AgentV3.ts:227

getEntities

getEntities(params: Entities): Promise<AgentGetEntitiesResults>
Parameters
- params: Entities
Returns Promise<AgentGetEntitiesResults>
- Defined in api/facades/agent/AgentV3.ts:243

isMaster

isMaster(params: any): Promise<IsMasterResult>
Parameters
- params: any
Returns Promise<IsMasterResult>
- Defined in api/facades/agent/AgentV3.ts:259

modelConfig

modelConfig(params: any): Promise<ModelConfigResult>
ModelConfig returns the current model's configuration.
Parameters
- params: any
Returns Promise<ModelConfigResult>
- Defined in api/facades/agent/AgentV3.ts:275

setPasswords

setPasswords(params: EntityPasswords): Promise<ErrorResults>
SetPasswords sets the given password for each supplied entity, if possible.
Parameters
- params: EntityPasswords
Returns Promise<ErrorResults>
- Defined in api/facades/agent/AgentV3.ts:291

stateServingInfo

stateServingInfo(params: any): Promise<StateServingInfo>
Parameters
- params: any
Returns Promise<StateServingInfo>
- Defined in api/facades/agent/AgentV3.ts:307

watchCloudSpecsChanges

watchCloudSpecsChanges(params: Entities): Promise<NotifyWatchResults>
WatchCloudSpecsChanges returns a watcher for cloud spec changes.
Parameters
- params: Entities
Returns Promise<NotifyWatchResults>
- Defined in api/facades/agent/AgentV3.ts:323

watchCredentials

watchCredentials(params: Entities): Promise<NotifyWatchResults>
WatchCredentials watches for changes to the specified credentials.
Parameters
- params: Entities
Returns Promise<NotifyWatchResults>
- Defined in api/facades/agent/AgentV3.ts:339

watchForModelConfigChanges

watchForModelConfigChanges(params: any): Promise<NotifyWatchResult>
WatchForModelConfigChanges returns a NotifyWatcher that observes changes to the model configuration. Note that although the NotifyWatchResult contains an Error field, it's not used because we are only returning a single watcher, so we use the regular error return.
Parameters
- params: any
Returns Promise<NotifyWatchResult>
- Defined in api/facades/agent/AgentV3.ts:359

Generated using TypeDoc