com.databricks.sdk.core.error.details

Class ResourceInfo

java.lang.Object

com.databricks.sdk.core.error.details.ResourceInfo

public abstract class ResourceInfo
extends Object

ResourceInfo describes the resource that is being accessed.

This error detail type provides information about the specific resource that was involved in the error. This is particularly useful when the error is related to resource access, permissions, or resource-specific operations.

ResourceInfo helps clients understand:

• What resource was involved in the error
• What type of resource it was
• Who owns the resource (if applicable)
• What specific error occurred when accessing the resource

Examples of when ResourceInfo might be provided:

• Permission denied errors
• Resource not found errors
• Resource conflict errors
• Resource quota exceeded errors
• Resource state validation errors

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ResourceInfo()

Method Summary

Modifier and Type	Method and Description
static ResourceInfo.Builder	builder() Creates a new builder for constructing ResourceInfo instances.
abstract String	description() Describes what error is encountered when accessing this resource.
abstract String	owner() The owner of the resource (optional).
abstract String	resourceName() The name of the resource being accessed.
abstract String	resourceType() A name for the type of resource being accessed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceInfo

public ResourceInfo()

Method Detail

resourceType

public abstract String resourceType()

A name for the type of resource being accessed.

This field categorizes the resource by its type or class. Examples might include:

• "workspace"
• "cluster"
• "job"
• "table"
• "user"
• "group"
• "secret"
• "notebook"

This information helps clients understand what category of resource was involved and potentially implement resource-type-specific error handling.

Returns:

the type of resource

resourceName

public abstract String resourceName()

The name of the resource being accessed.

This field provides the specific identifier or name of the resource that was involved in the error. The format depends on the resource type but typically includes:

• Resource IDs (e.g., "12345")
• Resource names (e.g., "my-cluster")
• Resource paths (e.g., "/path/to/resource")
• Resource URIs (e.g., "databricks://workspace/123")

This identifier helps clients locate the specific resource and potentially retry the operation or report the issue more precisely.

Returns:

the name or identifier of the resource

owner

public abstract String owner()

The owner of the resource (optional).

This field identifies who owns or controls the resource. This information is particularly useful for permission-related errors or when the client needs to contact the resource owner.

Examples of owner values:

• User email addresses
• User IDs
• Group names
• Service account identifiers
• Organization names

Note: This field may be null or empty if the owner information is not available or not applicable.

Returns:

the owner of the resource, or null if not available

description

public abstract String description()

Describes what error is encountered when accessing this resource.

This field provides a human-readable description of the specific error that occurred when trying to access or operate on the resource. The description should be clear enough for developers to understand what went wrong.

Examples of resource error descriptions:

• "Resource not found"
• "Access denied: insufficient permissions"
• "Resource is currently locked by another operation"
• "Resource quota exceeded"
• "Resource is in an invalid state for this operation"
• "Resource name contains invalid characters"
• "Resource already exists with this name"

Returns:

description of the resource access error

builder

public static ResourceInfo.Builder builder()

Creates a new builder for constructing ResourceInfo instances.

Returns:

a new builder instance