Databricks SDK for JavaScript
    Preparing search index...

    Interface Migration

    A persistent object tracking the full lifecycle of migrating one Classic compute asset to Serverless. Each Migration has a well-defined state machine and is the unit of orchestration, approval, and rollback.

    interface Migration {
        assetType?: Migration_AssetType;
        assetUri?: string;
        autoApprove?: boolean;
        bakingConfig?: BakingConfig;
        bakingReport?: BakingReport;
        createTime?: Instant;
        etag?: string;
        initiator?: Migration_Initiator;
        migrationId?: string;
        migrationReport?: MigrationReport;
        runValidation?: boolean;
        state?: Migration_State;
        stateHistory?: Migration_StateTransition[];
        validationReport?: ValidationReport;
    }
    Index

    Properties

    assetType? assetUri? autoApprove? bakingConfig? bakingReport? createTime? etag? initiator? migrationId? migrationReport? runValidation? state? stateHistory? validationReport?

    Properties

    assetType?: Migration_AssetType

    Type of Classic compute asset being migrated. Cannot be changed after creation.

    assetUri?: string

    URI of the source asset (e.g., "jobs/12345"). Cannot be changed after creation.

    autoApprove?: boolean

    When true, the server skips the translation review (TRANSLATION_READY) instead of waiting for an explicit ApproveMigrationTranslation. MIGRATION_REVIEW is never skipped. Unset/false means the translation review requires explicit user action. Set at creation; cannot be changed afterward. Does not suppress cancellation or terminal failures.

    bakingConfig?: BakingConfig

    Baking window configuration. Mutable via UpdateMigration before baking starts.

    bakingReport?: BakingReport

    Summary of baking metrics after the baking window completes.

    createTime?: Instant

    Timestamp when the migration was created.

    etag?: string

    Resource version for optimistic concurrency control. Clients read this from GetMigration or ListMigrations and pass it back as the request etag on update, delete, approve, reject, and cancel methods.

    initiator?: Migration_Initiator

    The user who initiated this migration and their role. Set at creation.

    migrationId?: string

    Server-generated unique identifier for this migration.

    migrationReport?: MigrationReport

    Agent-produced planning report, presented to the user at the review gates.

    runValidation?: boolean

    When true, Databricks runs the working copy to validate it after the translation review. Unset/false skips the run, so the migration goes from the translation review straight to execution review. Whether the translation review waits for the user is controlled by auto_approve, not this field. Set at creation; cannot be changed afterward.

    state?: Migration_State

    Current state of the migration in the state machine. Managed by the server.

    stateHistory?: Migration_StateTransition[]

    History of state transitions, ordered chronologically. Each entry records the state entered and the timestamp of the transition.

    validationReport?: ValidationReport

    Agent-produced validation results from sandbox execution.

    Settings

    Member Visibility

    On This Page

    Properties