Runtime
OCP App SDK / Runtime
Class: Runtime
Defined in: src/app/Runtime.ts:34
Constructors
Constructor
Returns
Runtime
Accessors
baseDir
Get Signature
Defined in: src/app/Runtime.ts:64
Returns
string
manifest
Get Signature
Defined in: src/app/Runtime.ts:60
Returns
Readonly<AppManifest>
Methods
getChannelClass()
Defined in: src/app/Runtime.ts:83
Type Parameters
T
T extends Channel
Returns
Promise<() => T>
getDestinationClass()
Defined in: src/app/Runtime.ts:112
Type Parameters
T
T extends Destination<any>
Parameters
name
string
Returns
Promise<() => T>
getDestinationSchema()
Defined in: src/app/Runtime.ts:193
Returns
getDestinationSchemaFunctionClass()
Defined in: src/app/Runtime.ts:134
Type Parameters
T
T extends DestinationSchemaFunction
Parameters
name
string
Returns
Promise<(config) => T>
getFunctionClass()
Defined in: src/app/Runtime.ts:69
Type Parameters
T
T extends Function
Parameters
name
string
Returns
Promise<(request) => T>
getJobClass()
Defined in: src/app/Runtime.ts:87
Type Parameters
T
T extends Job
Parameters
name
string
Returns
Promise<(invocation) => T>
getLifecycleClass()
Defined in: src/app/Runtime.ts:79
Type Parameters
T
T extends Lifecycle
Returns
Promise<() => T>
getLiquidExtensionClass()
Defined in: src/app/Runtime.ts:179
Type Parameters
T
T extends LiquidExtension
Parameters
name
string
Returns
Promise<() => T>
getSchemaObjects()
Defined in: src/app/Runtime.ts:189
Returns
SchemaObjects
getSourceFunctionClass()
Defined in: src/app/Runtime.ts:166
Type Parameters
T
T extends SourceFunction
Parameters
name
string
Returns
Promise<(config, request, source) => T>
getSourceJobClass()
Defined in: src/app/Runtime.ts:97
Type Parameters
T
T extends SourceJob
Parameters
sourceName
string
jobName
string
Returns
Promise<(invocation, source) => T>
getSourceLifecycleClass()
Defined in: src/app/Runtime.ts:121
Type Parameters
T
T extends SourceLifecycle
Parameters
name
string
Returns
Promise<null | (config) => T>
getSourceSchema()
Defined in: src/app/Runtime.ts:197
Returns
getSourceSchemaFunctionClass()
Defined in: src/app/Runtime.ts:150
Type Parameters
T
T extends SourceSchemaFunction
Parameters
name
string
Returns
Promise<(config) => T>
toJson()
Defined in: src/app/Runtime.ts:212
Returns
string
fromJson()
Defined in: src/app/Runtime.ts:50
Initializes from a pre-validated JSON definition. Used during task execution.
Parameters
serializedRuntime
string
JSON-serialized runtime definition
Returns
Runtime
initialize()
Defined in: src/app/Runtime.ts:40
Initializes from a directory. Used during startup.
Parameters
dirName
string
the base directory of the app
skipJsonValidation
boolean = false
for internal use, allows json-schema errors to be captured by the validation process
Returns
Promise<Runtime>