com.databricks.sdk.core.error.details

Class Help.HelpLink

java.lang.Object

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

Enclosing class:

Help

public abstract static class Help.HelpLink
extends Object

HelpLink provides a single helpful resource for resolving an error.

Each link should be specific to the error context and provide actionable guidance that users can follow to resolve their issue.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
HelpLink()

Method Summary

Modifier and Type	Method and Description
static Help.HelpLink.Builder	builder() Creates a new builder for constructing HelpLink instances.
abstract String	description() Describes what the link offers.
abstract String	url() The URL of the link.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpLink

public HelpLink()

Method Detail

description

public abstract String description()

Describes what the link offers.

This field provides a human-readable description of what users can expect to find when they follow the link. The description should be clear and specific enough for users to decide whether the link is relevant to their situation.

Examples of link descriptions:

• "Enable the service in the developer console"
• "View API rate limiting documentation"
• "Check your authentication configuration"
• "Learn about required permissions"
• "Troubleshoot common connection issues"
• "Contact support for this error"
• "View example code and usage patterns"
• "Check service status and known issues"

A good description helps users understand:

• What the link will help them with
• Whether it's relevant to their specific error
• What they can expect to learn or accomplish

Returns:

description of what the link offers

url

public abstract String url()

The URL of the link.

This field contains the actual URL that users can follow to access the helpful resource. The URL should be:

• Accessible to the user (not requiring special access)
• Stable and not likely to change frequently
• Secure (HTTPS for web resources)
• Relevant to the current error context

Examples of helpful URLs:

• Documentation pages: "https://docs.example.com/errors/rate-limit"
• Developer console: "https://console.example.com/settings/api"
• Support forms: "https://support.example.com/contact"
• Knowledge base: "https://help.example.com/troubleshooting"
• Community forums: "https://community.example.com/errors"

Returns:

the URL of the helpful resource

builder

public static Help.HelpLink.Builder builder()

Creates a new builder for constructing HelpLink instances.

Returns:

a new builder instance