Type Alias DataTaskInstanceState

Represents the execution state of a task instance, including progress metrics, errors, and operation-specific statistics.

type DataTaskInstanceState = {
    cdcStatus?: {
        accumulatingChangesCount?: number;
        applyingChangesCount?: number;
        incomingChangesCount?: number;
        latency?: string;
        throughputInKilobytesPerSecond?: number;
        totalProcessedCount?: number;
    };
    duration?: string;
    endTime?: string;
    errors?: Error[];
    fullLoad?: {
        completedCount?: number;
        errorCount?: number;
        loadingCount?: number;
        queuedCount?: number;
    };
    general?: {
        datasetCount?: number;
        datasetsInErrorCount?: number;
        dataTaskUpdatedTo?: string;
        gatewayId?: string;
        gatewayName?: string;
        gatewayTaskName?: string;
        lakehouseClusterId?: string;
        lakehouseClusterName?: string;
        liveViewsUpdatedTo?: string;
    };
    lastBatchOfChanges?: {
        relatesToRecordsFrom?: string;
        relatesToRecordsTo?: string;
        throughputInRecordsPerSecond?: number;
        totalProcessedCount?: number;
    };
    message?: string;
    startTime?: string;
    state?: | "STARTING"
    | "RUNNING"
    | "COMPLETED"
    | "FAILED"
    | "CANCELED"
    | "STOPPING";
    streaming?: {
        errorCount?: number;
        latency?: string;
        queuedCount?: number;
        runningCount?: number;
        totalProcessedCount?: number;
    };
    traceId?: string;
}
Index

Properties

cdcStatus? duration? endTime? errors? fullLoad? general? lastBatchOfChanges? message? startTime? state? streaming? traceId?

Properties

cdcStatus?: {
    accumulatingChangesCount?: number;
    applyingChangesCount?: number;
    incomingChangesCount?: number;
    latency?: string;
    throughputInKilobytesPerSecond?: number;
    totalProcessedCount?: number;
}

Change Data Capture status information for tasks performing incremental updates, including latency and processing counts.

duration?: string
endTime?: string
errors?: Error[]
fullLoad?: {
    completedCount?: number;
    errorCount?: number;
    loadingCount?: number;
    queuedCount?: number;
}

Type Declaration

  • OptionalcompletedCount?: number

    Number of datasets that have completed full load in this task run

  • OptionalerrorCount?: number
  • OptionalloadingCount?: number
  • OptionalqueuedCount?: number
general?: {
    datasetCount?: number;
    datasetsInErrorCount?: number;
    dataTaskUpdatedTo?: string;
    gatewayId?: string;
    gatewayName?: string;
    gatewayTaskName?: string;
    lakehouseClusterId?: string;
    lakehouseClusterName?: string;
    liveViewsUpdatedTo?: string;
}

Type Declaration

  • OptionaldatasetCount?: number
  • OptionaldatasetsInErrorCount?: number
  • OptionaldataTaskUpdatedTo?: string

    The latest point in time the data reflects, based on updates from the source system.

  • OptionalgatewayId?: string
  • OptionalgatewayName?: string
  • OptionalgatewayTaskName?: string
  • OptionallakehouseClusterId?: string
  • OptionallakehouseClusterName?: string
  • OptionalliveViewsUpdatedTo?: string
lastBatchOfChanges?: {
    relatesToRecordsFrom?: string;
    relatesToRecordsTo?: string;
    throughputInRecordsPerSecond?: number;
    totalProcessedCount?: number;
}

Type Declaration

  • OptionalrelatesToRecordsFrom?: string

    This batch starts with operational source changes from this time.

  • OptionalrelatesToRecordsTo?: string
  • OptionalthroughputInRecordsPerSecond?: number
  • OptionaltotalProcessedCount?: number
message?: string
startTime?: string
state?:
    | "STARTING"
    | "RUNNING"
    | "COMPLETED"
    | "FAILED"
    | "CANCELED"
    | "STOPPING"
streaming?: {
    errorCount?: number;
    latency?: string;
    queuedCount?: number;
    runningCount?: number;
    totalProcessedCount?: number;
}

Type Declaration

  • OptionalerrorCount?: number

    Number of streaming datasets that have encountered errors

  • Optionallatency?: string
  • OptionalqueuedCount?: number
  • OptionalrunningCount?: number
  • OptionaltotalProcessedCount?: number
traceId?: string

Settings

Member Visibility

On This Page

Properties