Databricks SDK for JavaScript
    Preparing search index...

    ApiError is a transport-agnostic error representing a Databricks API error.

    Hierarchy

    • Error
      • ApiError
    Index

    Properties

    cause?: unknown
    code: Code

    The error code of the error.

    details: ErrorDetails

    The structured error details of the error. This is left empty if the error response is not a standard Databricks API error.

    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Accessors

    • get httpBody(): Uint8Array<ArrayBufferLike> | undefined

      Returns the ApiError's HTTP body. If the ApiError is not an HTTP error, returns undefined.

      Returns Uint8Array<ArrayBufferLike> | undefined

    • get httpHeader(): Headers | undefined

      Returns the ApiError's HTTP headers. If the ApiError is not an HTTP error, returns undefined.

      Returns Headers | undefined

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parses an HTTP error response into an ApiError. Returns undefined if the status code is 2xx.

      Parameters

      • statusCode: number
      • header: Headers | undefined
      • body: Uint8Array<ArrayBufferLike> | undefined

      Returns ApiError | undefined