Runtime
OCP App SDK / Runtime
Class: Runtime
Defined in: src/app/Runtime.ts:34
Constructors
Constructor
new Runtime():
Runtime
Returns
Runtime
Accessors
baseDir
Get Signature
get baseDir():
string
Defined in: src/app/Runtime.ts:64
Returns
string
manifest
Get Signature
get manifest():
Readonly
<AppManifest
>
Defined in: src/app/Runtime.ts:60
Returns
Readonly
<AppManifest
>
Methods
getChannelClass()
getChannelClass<
T
>():Promise
<() =>T
>
Defined in: src/app/Runtime.ts:83
Type Parameters
T
T
extends Channel
Returns
Promise
<() => T
>
getDestinationClass()
getDestinationClass<
T
>(name
):Promise
<() =>T
>
Defined in: src/app/Runtime.ts:112
Type Parameters
T
T
extends Destination
<any
>
Parameters
name
string
Returns
Promise
<() => T
>
getDestinationSchema()
getDestinationSchema():
DestinationSchemaObjects
Defined in: src/app/Runtime.ts:193
Returns
getDestinationSchemaFunctionClass()
getDestinationSchemaFunctionClass<
T
>(name
):Promise
<(config
) =>T
>
Defined in: src/app/Runtime.ts:134
Type Parameters
T
T
extends DestinationSchemaFunction
Parameters
name
string
Returns
Promise
<(config
) => T
>
getFunctionClass()
getFunctionClass<
T
>(name
):Promise
<(request
) =>T
>
Defined in: src/app/Runtime.ts:69
Type Parameters
T
T
extends Function
Parameters
name
string
Returns
Promise
<(request
) => T
>
getJobClass()
getJobClass<
T
>(name
):Promise
<(invocation
) =>T
>
Defined in: src/app/Runtime.ts:87
Type Parameters
T
T
extends Job
Parameters
name
string
Returns
Promise
<(invocation
) => T
>
getLifecycleClass()
getLifecycleClass<
T
>():Promise
<() =>T
>
Defined in: src/app/Runtime.ts:79
Type Parameters
T
T
extends Lifecycle
Returns
Promise
<() => T
>
getLiquidExtensionClass()
getLiquidExtensionClass<
T
>(name
):Promise
<() =>T
>
Defined in: src/app/Runtime.ts:179
Type Parameters
T
T
extends LiquidExtension
Parameters
name
string
Returns
Promise
<() => T
>
getSchemaObjects()
getSchemaObjects():
SchemaObjects
Defined in: src/app/Runtime.ts:189
Returns
SchemaObjects
getSourceFunctionClass()
getSourceFunctionClass<
T
>(name
):Promise
<(config
,request
,source
) =>T
>
Defined in: src/app/Runtime.ts:166
Type Parameters
T
T
extends SourceFunction
Parameters
name
string
Returns
Promise
<(config
, request
, source
) => T
>
getSourceJobClass()
getSourceJobClass<
T
>(sourceName
,jobName
):Promise
<(invocation
,source
) =>T
>
Defined in: src/app/Runtime.ts:97
Type Parameters
T
T
extends SourceJob
Parameters
sourceName
string
jobName
string
Returns
Promise
<(invocation
, source
) => T
>
getSourceLifecycleClass()
getSourceLifecycleClass<
T
>(name
):Promise
<null
| (config
) =>T
>
Defined in: src/app/Runtime.ts:121
Type Parameters
T
T
extends SourceLifecycle
Parameters
name
string
Returns
Promise
<null
| (config
) => T
>
getSourceSchema()
getSourceSchema():
SourceSchemaObjects
Defined in: src/app/Runtime.ts:197
Returns
getSourceSchemaFunctionClass()
getSourceSchemaFunctionClass<
T
>(name
):Promise
<(config
) =>T
>
Defined in: src/app/Runtime.ts:150
Type Parameters
T
T
extends SourceSchemaFunction
Parameters
name
string
Returns
Promise
<(config
) => T
>
toJson()
toJson():
string
Defined in: src/app/Runtime.ts:212
Returns
string
fromJson()
static
fromJson(serializedRuntime
):Runtime
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()
static
initialize(dirName
,skipJsonValidation
):Promise
<Runtime
>
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
>
Updated 8 days ago