Class: ExeUnit

activity/exe-unit/exe-unit.ExeUnit

Groups most common operations that the requestors might need to implement their workflows

• constructor

• provider
• activity
• activityModule

• setup
• teardown
• run
• runAndStream
• transfer
• uploadFile
• uploadJson
• uploadData
• downloadFile
• downloadData
• downloadJson
• beginBatch
• getWebsocketUri
• getIp
• createTcpProxy
• getDto

• new ExeUnit(activity, activityModule, options?): ExeUnit

ExeUnit

src/activity/exe-unit/exe-unit.ts:69

• Readonly provider: ProviderInfo

src/activity/exe-unit/exe-unit.ts:60

• Readonly activity: Activity

src/activity/exe-unit/exe-unit.ts:70

• Readonly activityModule: ActivityModule

src/activity/exe-unit/exe-unit.ts:71

▸ setup(): Promise<void | Result<any>[]>

This function initializes the exe unit by deploying the image to the remote machine and preparing and running the environment. This process also includes running setup function if the user has defined it

Promise<void | Result<any>[]>

src/activity/exe-unit/exe-unit.ts:110

▸ teardown(): Promise<void>

This function starts the teardown function if the user has defined it. It is run before the machine is destroyed.

Promise<void>

src/activity/exe-unit/exe-unit.ts:152

▸ run(commandLine, options?): Promise<Result<any>>

Execute a command on provider using a shell (/bin/sh).

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:198

▸ run(executable, args, options?): Promise<Result<any>>

Execute an executable on provider.

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:207

▸ runAndStream(commandLine, options?): Promise<RemoteProcess>

Run an executable on provider and return RemoteProcess that will allow streaming that contain stdout and stderr as Readable

Promise<RemoteProcess>

src/activity/exe-unit/exe-unit.ts:231

▸ runAndStream(executable, args, options?): Promise<RemoteProcess>

Promise<RemoteProcess>

src/activity/exe-unit/exe-unit.ts:237

▸ transfer(from, to, options?): Promise<Result<any>>

Generic transfer command, requires the user to provide a publicly readable transfer source

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:272

▸ uploadFile(src, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:277

▸ uploadJson(json, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:283

▸ uploadData(data, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:289

▸ downloadFile(src, dst, options?): Promise<Result<any>>

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:294

▸ downloadData(src, options?): Promise<Result<Uint8Array>>

Promise<Result<Uint8Array>>

src/activity/exe-unit/exe-unit.ts:299

▸ downloadJson(src, options?): Promise<Result<any>>

Promise<Result<any>>

src/activity/exe-unit/exe-unit.ts:304

▸ beginBatch(): Batch

Batch

src/activity/exe-unit/exe-unit.ts:320

▸ getWebsocketUri(port): string

Provides a WebSocket URI that allows communicating with a remote process listening on the target port

string

src/activity/exe-unit/exe-unit.ts:329

▸ getIp(): string

string

src/activity/exe-unit/exe-unit.ts:342

▸ createTcpProxy(portOnProvider): TcpProxy

Creates a new TCP proxy that will allow tunnelling the TPC traffic from the provider via the requestor

TcpProxy

src/activity/exe-unit/exe-unit.ts:359

▸ getDto(): ActivityDTO

ActivityDTO

src/activity/exe-unit/exe-unit.ts:369