com.databricks.sdk.core.error.details

Class ErrorInfo

java.lang.Object

com.databricks.sdk.core.error.details.ErrorInfo

public abstract class ErrorInfo
extends Object

ErrorInfo describes the cause of the error with structured details.

This class provides structured information about what went wrong, including:

• The reason for the error (a constant value identifying the proximate cause)
• The logical grouping to which the "reason" belongs
• Additional structured details about the error

This information can be used by clients to:

• Understand what went wrong
• Provide better error messages to users
• Implement appropriate error handling logic
• Debug issues more effectively

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorInfo.Builder Builder for constructing ErrorInfo instances.

Constructor Summary

Constructors

Constructor and Description
ErrorInfo()

Method Summary

Modifier and Type	Method and Description
static ErrorInfo.Builder	builder() Creates a new builder for constructing ErrorInfo instances.
abstract String	domain() The logical grouping to which the "reason" belongs.
abstract Map<String,String>	metadata() Additional structured details about this error.
abstract String	reason() The reason of the error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ErrorInfo

public ErrorInfo()

Method Detail

reason

public abstract String reason()

The reason of the error. This is a constant value that identifies the proximate cause of the error.

Examples might include: "INVALID_ARGUMENT", "RESOURCE_NOT_FOUND", "PERMISSION_DENIED", etc.

Returns:

the reason for the error

domain

public abstract String domain()

The logical grouping to which the "reason" belongs.

This provides context about the domain or category of the error. Examples might include: "databricks.api", "databricks.auth", etc.

Returns:

the domain of the error

metadata

public abstract Map<String,String> metadata()

Additional structured details about this error.

This map can contain arbitrary key-value pairs that provide additional context about the error. The exact contents depend on the specific error type and the service implementation.

Returns:

additional metadata about the error

builder

public static ErrorInfo.Builder builder()

Creates a new builder for constructing ErrorInfo instances.

Returns:

a new builder instance