Type Alias DataTaskInstanceState

type DataTaskInstanceState = {
    cdcStatus?: {
        accumulatingChangesCount?: number;
        applyingChangesCount?: number;
        latency?: string;
        throughputInKilobytesPerSecond?: number;
        totalProcessedCount?: number;
    };
    duration?: string;
    endTime?: string;
    fullLoad?: {
        completedCount?: number;
        errorCount?: number;
        loadingCount?: number;
        queuedCount?: number;
    };
    general?: {
        datasetCount?: number;
        datasetsInErrorCount?: number;
        dataTaskUpdatedTo?: string;
        gatewayId?: string;
        gatewayName?: string;
        gatewayTaskName?: 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";
}
Index

Properties

cdcStatus? duration? endTime? fullLoad? general? lastBatchOfChanges? message? startTime? state?

Properties

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

Type Declaration

  • OptionalaccumulatingChangesCount?: number
  • OptionalapplyingChangesCount?: number
  • Optionallatency?: string

    Duration in HH:MM:SS format (hours:minutes:seconds)

  • OptionalthroughputInKilobytesPerSecond?: number

    Throughput in kilobytes per second

  • OptionaltotalProcessedCount?: number
duration?: string

Duration in HH:MM:SS format (hours:minutes:seconds)

endTime?: string

Timestamp indicating when the task instance ended

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

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

  • OptionalloadingCount?: number

    Number of datasets that are currently being loaded in this task run

  • OptionalqueuedCount?: number

    Number of datasets that are queued for full load in this task run

general?: {
    datasetCount?: number;
    datasetsInErrorCount?: number;
    dataTaskUpdatedTo?: string;
    gatewayId?: string;
    gatewayName?: string;
    gatewayTaskName?: string;
    lakehouseClusterName?: string;
    liveViewsUpdatedTo?: string;
}

Type Declaration

  • OptionaldatasetCount?: number

    Total number of datasets produced by the task, including ones in error

  • OptionaldatasetsInErrorCount?: number

    Count of datasets that encountered errors

  • OptionaldataTaskUpdatedTo?: string

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

  • OptionalgatewayId?: string

    For tasks that run on a gateway, this is the id of the gateway

  • OptionalgatewayName?: string

    For tasks that run on a gateway, this is the name of the gateway

  • OptionalgatewayTaskName?: string

    For tasks that run on a gateway, this is the internal name of the task on the gateway

  • OptionallakehouseClusterName?: string

    For lakehouse storage tasks, this is the name of the cluster where the task runs

  • OptionalliveViewsUpdatedTo?: string

    The latest point in time the live views reflect, based on updates from the source system.

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

    This batch ends with operational source changes from this time.

  • OptionalthroughputInRecordsPerSecond?: number

    Throughput in records per second

  • OptionaltotalProcessedCount?: number
message?: string
startTime?: string

Timestamp indicating when the task instance started

state?:
    | "STARTING"
    | "RUNNING"
    | "COMPLETED"
    | "FAILED"
    | "CANCELED"
    | "STOPPING"

Settings

Member Visibility

On This Page

Properties