Class default

ModelUpgraderAPI implements the model upgrader interface and is the concrete implementation of the api end point.

Hierarchy

default

Implements

Facade

Index

Constructors

Properties

NAME VERSION _info _transport NAME VERSION

Methods

abortModelUpgrade upgradeModel

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/model-upgrader/ModelUpgraderV1.ts:68

Properties

NAME

NAME: string = "ModelUpgrader"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "ModelUpgrader"

`Static` VERSION

VERSION: number = 1

Methods

abortModelUpgrade

abortModelUpgrade(params: ModelParam): Promise<any>
AbortModelUpgrade aborts and archives the model upgrade synchronisation record, if any.
Parameters
- params: ModelParam
Returns Promise<any>
- Defined in api/facades/model-upgrader/ModelUpgraderV1.ts:79

upgradeModel

upgradeModel(params: UpgradeModelParams): Promise<UpgradeModelResult>
UpgradeModel upgrades a model.
Parameters
- params: UpgradeModelParams
Returns Promise<UpgradeModelResult>
- Defined in api/facades/model-upgrader/ModelUpgraderV1.ts:95

Generated using TypeDoc