Databricks SDK for JavaScript
    Preparing search index...

    Interface GetRunOutputResponse

    Run output was retrieved successfully.

    interface GetRunOutputResponse {
        error?: string;
        errorTrace?: string;
        info?: string;
        logs?: string;
        logsTruncated?: boolean;
        metadata?: Run;
        result?:
            | {
                $case: "notebookOutput";
                notebookOutput: NotebookTask_NotebookOutput;
            }
            | { $case: "sqlOutput"; sqlOutput: SqlTask_SqlOutput }
            | { $case: "dbtOutput"; dbtOutput: DbtTask_DbtTaskOutput }
            | { $case: "runJobOutput"; runJobOutput: RunJobTask_RunJobTaskOutput }
            | {
                $case: "cleanRoomsNotebookOutput";
                cleanRoomsNotebookOutput: CleanRoomsNotebookTask_CleanRoomsNotebookTaskOutput;
            }
            | { $case: "dashboardOutput"; dashboardOutput: DashboardTaskOutput }
            | { $case: "dbtCloudOutput"; dbtCloudOutput: DbtCloudTaskOutput }
            | { $case: "dbtPlatformOutput"; dbtPlatformOutput: DbtPlatformTaskOutput }
            | { $case: "alertOutput"; alertOutput: AlertTaskOutput }
            | {
                $case: "aiRuntimeTaskOutput";
                aiRuntimeTaskOutput: AiRuntimeTaskOutput;
            };
    }
    Index

    Properties

    error? errorTrace? info? logs? logsTruncated? metadata? result?

    Properties

    error?: string

    An error message indicating why a task failed or why output is not available. The message is unstructured, and its exact format is subject to change.

    errorTrace?: string

    If there was an error executing the run, this field contains any available stack traces.

    info?: string
    logs?: string

    The output from tasks that write to standard streams (stdout/stderr) such as spark_jar_task, spark_python_task, python_wheel_task.

    It's not supported for the notebook_task, pipeline_task or spark_submit_task.

    restricts this API to return the last 5 MB of these logs.

    logsTruncated?: boolean

    Whether the logs are truncated.

    metadata?: Run

    All details of the run except for its output.

    result?:
        | {
            $case: "notebookOutput";
            notebookOutput: NotebookTask_NotebookOutput;
        }
        | { $case: "sqlOutput"; sqlOutput: SqlTask_SqlOutput }
        | { $case: "dbtOutput"; dbtOutput: DbtTask_DbtTaskOutput }
        | { $case: "runJobOutput"; runJobOutput: RunJobTask_RunJobTaskOutput }
        | {
            $case: "cleanRoomsNotebookOutput";
            cleanRoomsNotebookOutput: CleanRoomsNotebookTask_CleanRoomsNotebookTaskOutput;
        }
        | { $case: "dashboardOutput"; dashboardOutput: DashboardTaskOutput }
        | { $case: "dbtCloudOutput"; dbtCloudOutput: DbtCloudTaskOutput }
        | { $case: "dbtPlatformOutput"; dbtPlatformOutput: DbtPlatformTaskOutput }
        | { $case: "alertOutput"; alertOutput: AlertTaskOutput }
        | {
            $case: "aiRuntimeTaskOutput";
            aiRuntimeTaskOutput: AiRuntimeTaskOutput;
        }

    Type Declaration

    • { $case: "notebookOutput"; notebookOutput: NotebookTask_NotebookOutput }
      • $case: "notebookOutput"
      • notebookOutput: NotebookTask_NotebookOutput

        The output of a notebook task, if available. A notebook task that terminates (either successfully or with a failure) without calling dbutils.notebook.exit() is considered to have an empty output. This field is set but its result value is empty. restricts this API to return the first 5 MB of the output. To return a larger result, use the ClusterLogConf field to configure log storage for the job cluster.

    • { $case: "sqlOutput"; sqlOutput: SqlTask_SqlOutput }
      • $case: "sqlOutput"
      • sqlOutput: SqlTask_SqlOutput

        The output of a SQL task, if available.

    • { $case: "dbtOutput"; dbtOutput: DbtTask_DbtTaskOutput }
    • { $case: "runJobOutput"; runJobOutput: RunJobTask_RunJobTaskOutput }
    • {
          $case: "cleanRoomsNotebookOutput";
          cleanRoomsNotebookOutput: CleanRoomsNotebookTask_CleanRoomsNotebookTaskOutput;
      }
    • { $case: "dashboardOutput"; dashboardOutput: DashboardTaskOutput }
      • $case: "dashboardOutput"
      • dashboardOutput: DashboardTaskOutput

        The output of a dashboard task, if available

    • { $case: "dbtCloudOutput"; dbtCloudOutput: DbtCloudTaskOutput }
      • $case: "dbtCloudOutput"
      • dbtCloudOutput: DbtCloudTaskOutput

        Deprecated in favor of the new dbt_platform_output

    • { $case: "dbtPlatformOutput"; dbtPlatformOutput: DbtPlatformTaskOutput }
    • { $case: "alertOutput"; alertOutput: AlertTaskOutput }
      • $case: "alertOutput"
      • alertOutput: AlertTaskOutput

        The output of an alert task, if available

    • { $case: "aiRuntimeTaskOutput"; aiRuntimeTaskOutput: AiRuntimeTaskOutput }
      • $case: "aiRuntimeTaskOutput"
      • aiRuntimeTaskOutput: AiRuntimeTaskOutput

        The output of an AiRuntimeTask, if available — MLflow identifiers, artifact paths, and per-replica allocated compute. Run lifecycle / termination status lives on the surrounding framework RunTask.status (runs.proto:RunTask.status of type RunStatus), not on this output. See tasks/genai/ai_runtime_task.proto:AiRuntimeTaskOutput.

    Settings

    Member Visibility

    On This Page

    Properties