Databricks SDK for JavaScript
    Preparing search index...

    Interface Operation

    This resource represents a long-running operation that is the result of a network API call.

    interface Operation {
        done?: boolean;
        metadata?: Record<string, unknown>;
        name?: string;
        result?:
            | { $case: "error"; error: ApiError }
            | { $case: "response"; response: Record<string, unknown> };
    }
    Index

    Properties

    done? metadata? name? result?

    Properties

    done?: boolean

    If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

    metadata?: Record<string, unknown>

    Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata.

    name?: string

    The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

    result?:
        | { $case: "error"; error: ApiError }
        | { $case: "response"; response: Record<string, unknown> }

    The operation result, which can be either an error or a valid response. If done == false, neither error nor response is set. If done == true, exactly one of error or response can be set. Some services might not provide the result.

    Type Declaration

    • { $case: "error"; error: ApiError }
      • $case: "error"
      • error: ApiError

        The error result of the operation in case of failure or cancellation.

    • { $case: "response"; response: Record<string, unknown> }
      • $case: "response"
      • response: Record<string, unknown>

        The normal, successful response of the operation.

    Settings

    Member Visibility

    On This Page

    Properties