@versatiledatakit/data-pipelines/lib/model/data-job-base.model.d.ts

Data Pipelines help Data Engineers develop, deploy, run, and manage data processing workloads (called 'Data Job')

export interface StatusDetails {
    enabled: boolean;
}
export interface GraphQLResponsePage<T> {
    content?: T[];
    totalItems?: number;
    totalPages?: number;
}
export interface BaseDataJobDeployment<E extends DataJobExecution = DataJobExecution> extends StatusDetails {
    id: string;
    contacts?: DataJobContacts;
    jobVersion?: string;
    deployedDate?: string;
    deployedBy?: string;
    mode?: string;
    resources?: DataJobResources;
    schedule?: DataJobSchedule;
    vdkVersion?: string;
    jobPythonVersion?: string;
    status?: DataJobDeploymentStatus;
    executions?: E[];
}
export declare enum DataJobDeploymentStatus {
    NONE = "NONE",
    SUCCESS = "SUCCESS",
    PLATFORM_ERROR = "PLATFORM_ERROR",
    USER_ERROR = "USER_ERROR"
}
export interface DataJobContacts {
    notifiedOnJobFailureUserError: string[];
    notifiedOnJobFailurePlatformError: string[];
    notifiedOnJobSuccess: string[];
    notifiedOnJobDeploy: string[];
}
export interface DataJobSchedule {
    scheduleCron?: string;
    nextRunEpochSeconds?: number;
}
export interface DataJobResources {
    cpuLimit: number;
    cpuRequest: number;
    memoryLimit: number;
    memoryRequest: number;
    ephemeralStorageLimit?: number;
    ephemeralStorageRequest?: number;
    netBandwidthLimit?: number;
}
export interface DataJobExecution {
    id: string;
    type?: DataJobExecutionType;
    jobName?: string;
    status?: DataJobExecutionStatus;
    startTime?: string;
    endTime?: string;
    startedBy?: string;
    message?: string;
    opId?: string;
    logsUrl?: string;
    deployment?: BaseDataJobDeployment;
}
export declare enum DataJobExecutionType {
    MANUAL = "MANUAL",
    SCHEDULED = "SCHEDULED"
}
/**
 * ** Execution Status.
 */
export declare enum DataJobExecutionStatus {
    SUBMITTED = "SUBMITTED",
    RUNNING = "RUNNING",
    FINISHED = "FINISHED",
    SUCCEEDED = "SUCCEEDED",
    CANCELLED = "CANCELLED",
    SKIPPED = "SKIPPED",
    FAILED = "FAILED",
    USER_ERROR = "USER_ERROR",
    PLATFORM_ERROR = "PLATFORM_ERROR"
}