Databricks SDK for JavaScript
    Preparing search index...

    Interface ForkSessionRequest

    Request to fork a session.

    interface ForkSessionRequest {
        actorId?: string;
        metadata?: Record<string, string>;
        parent?: string;
        sessionId?: string;
        sourceSessionId?: string;
        upToItemId?: string;
    }
    Index

    Properties

    actorId? metadata? parent? sessionId? sourceSessionId? upToItemId?

    Properties

    actorId?: string

    Opaque caller-provided identifier for the application actor associated with the forked session.

    metadata?: Record<string, string>

    Optional metadata for the fork.

    parent?: string

    Resource name of the containing session store, in the form session-stores/{session_store_id}.

    sessionId?: string

    Optional unique ID for the forked session. A collision returns ALREADY_EXISTS.

    sourceSessionId?: string

    ID of the session to copy.

    upToItemId?: string

    Optional last item ID to copy through, inclusively. When omitted, the fork atomically copies all items committed before the fork operation begins.

    Settings

    Member Visibility

    On This Page

    Properties