Class default

API implements the API facade used by the machine undertaker.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

allMachineRemovals completeMachineRemovals getMachineProviderInterfaceInfo watchMachineRemovals

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/machine-undertaker/MachineUndertakerV1.ts:81

Properties

NAME

NAME: string = "MachineUndertaker"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "MachineUndertaker"

`Static` VERSION

VERSION: number = 1

Methods

allMachineRemovals

allMachineRemovals(params: Entities): Promise<EntitiesResults>
AllMachineRemovals returns tags for all of the machines that have been marked for removal in the requested model.
Parameters
- params: Entities
Returns Promise<EntitiesResults>
- Defined in api/facades/machine-undertaker/MachineUndertakerV1.ts:92

completeMachineRemovals

completeMachineRemovals(params: Entities): Promise<any>
CompleteMachineRemovals removes the specified machines from the model database. It should only be called once any provider-level cleanup has been done for those machines.
Parameters
- params: Entities
Returns Promise<any>
- Defined in api/facades/machine-undertaker/MachineUndertakerV1.ts:110

getMachineProviderInterfaceInfo

getMachineProviderInterfaceInfo(params: Entities): Promise<ProviderInterfaceInfoResults>
GetMachineProviderInterfaceInfo returns the provider details for all network interfaces attached to the machines requested.
Parameters
- params: Entities
Returns Promise<ProviderInterfaceInfoResults>
- Defined in api/facades/machine-undertaker/MachineUndertakerV1.ts:127

watchMachineRemovals

watchMachineRemovals(params: Entities): Promise<NotifyWatchResults>
WatchMachineRemovals returns a watcher that will signal each time a machine is marked for removal.
Parameters
- params: Entities
Returns Promise<NotifyWatchResults>
- Defined in api/facades/machine-undertaker/MachineUndertakerV1.ts:146

Generated using TypeDoc