com.databricks.sdk.core.error.details

Class Help

java.lang.Object

com.databricks.sdk.core.error.details.Help

public abstract class Help
extends Object

Help provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Help information is particularly useful for:

• Guiding users to self-service solutions
• Providing context-specific documentation
• Offering actionable steps to resolve issues
• Reducing support ticket volume
• Improving user experience during error scenarios

This type of error detail helps transform error responses from simple failure notifications into actionable guidance that users can follow to resolve their issues.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Help.Builder Builder for constructing Help instances.
static class	Help.HelpLink HelpLink provides a single helpful resource for resolving an error.

Constructor Summary

Constructors

Constructor and Description
Help()

Method Summary

Modifier and Type	Method and Description
static Help.Builder	builder() Creates a new builder for constructing Help instances.
abstract List<Help.HelpLink>	links() URL(s) pointing to additional information on handling the current error.

Methods inherited from class java.lang.Object

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

Constructor Detail

Help

public Help()

Method Detail

links

public abstract List<Help.HelpLink> links()

URL(s) pointing to additional information on handling the current error.

This list contains links to resources that can help users understand and resolve the error they encountered. Each link should provide specific, actionable guidance related to the current error context.

Examples of helpful links might include:

• Documentation pages explaining the error
• Troubleshooting guides
• Configuration pages in developer consoles
• Support contact forms
• Community forums or knowledge bases
• Video tutorials or walkthroughs
• API reference documentation

Returns:

the list of helpful links

builder

public static Help.Builder builder()

Creates a new builder for constructing Help instances.

Returns:

a new builder instance