Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TaskRun

The information about a task run.

Properties

Optional authMode

authMode: AuthMode

The autorization mode for when the task was executed.

Optional bytesProcessed

bytesProcessed: undefined | number

The number of bytes processed in the task run. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional configProvider

configProvider: model.ConfigProvider

Optional description

description: undefined | string

Detailed description for the object.

Optional endTimeMillis

endTimeMillis: undefined | number

The end time. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional errorMessage

errorMessage: undefined | string

Contains an error message if status is {@code ERROR}.

Optional executionErrors

executionErrors: Array<string>

An array of execution errors from the run.

Optional expectedDuration

expectedDuration: undefined | number

The expected duration for the task run. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional expectedDurationUnit

expectedDurationUnit: ExpectedDurationUnit

The expected duration unit of measure.

Optional externalId

externalId: undefined | string

The external identifier for the task run.

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional isLogProcessingInProgress

isLogProcessingInProgress: undefined | false | true

This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks.

Optional key

key: undefined | string

The key of the object.

Optional keyMap

keyMap: undefined | object

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Optional lastUpdated

lastUpdated: undefined | number

The date and time the object was last updated. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional metadata

metadata: model.ObjectMetadata

Optional metrics

metrics: undefined | object

A map of metrics for the run.

Optional modelType

modelType: undefined | string

The type of the object.

Optional modelVersion

modelVersion: undefined | string

The model version of an object.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

The version of the object that is used to track changes in the object instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional opcRequestId

opcRequestId: undefined | string

The OPC request ID of execution of the task run.

Optional outputs

outputs: undefined | object

A map of the outputs of the run.

Optional parentRef

parentRef: model.ParentReference

Optional recordsWritten

recordsWritten: undefined | number

The number of records processed in the task run. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional retryAttempt

retryAttempt: undefined | number

Holds the particular attempt number. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional startTimeMillis

startTimeMillis: undefined | number

The start time. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional status

status: Status

The status of the task run.

Optional taskKey

taskKey: undefined | string

Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey

Optional taskSchedule

taskSchedule: model.TaskSchedule

Optional taskType

taskType: TaskType

The type of task run.

Optional terminationErrors

terminationErrors: Array<string>

An array of termination errors from the run.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: TaskRun): object

getJsonObj