com.databricks.sdk.core.error.details

Class RetryInfo

java.lang.Object

com.databricks.sdk.core.error.details.RetryInfo

public abstract class RetryInfo
extends Object

RetryInfo describes when clients can retry a failed request.

Clients could ignore the recommendation here or retry when this information is missing from error responses. However, it's always recommended that clients should use exponential backoff when retrying.

Clients should wait until the retryDelay amount of time has passed since receiving the error response before retrying. If retrying requests also fail, clients should use an exponential backoff scheme to gradually increase the delay between retries based on retryDelay, until either a maximum number of retries have been reached or a maximum retry delay cap has been reached.

This information helps clients implement intelligent retry strategies that respect the service's recommendations while avoiding overwhelming the service with rapid retry attempts.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
RetryInfo()

Method Summary

Modifier and Type	Method and Description
static RetryInfo.Builder	builder() Creates a new builder for constructing RetryInfo instances.
abstract Duration	retryDelay() Clients should wait at least this long between retrying the same request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RetryInfo

public RetryInfo()

Method Detail

retryDelay

public abstract Duration retryDelay()

Clients should wait at least this long between retrying the same request.

Note: This is serialized as a string in the format "3.000000001s" where the string ends in the suffix "s" (indicating seconds) and is preceded by a decimal number of seconds.

Examples of valid formats:

• "30s" - 30 seconds
• "1.5s" - 1.5 seconds
• "0.001s" - 1 millisecond
• "3.000000001s" - 3 seconds and 1 nanosecond

Returns:

the recommended delay before retrying

builder

public static RetryInfo.Builder builder()

Creates a new builder for constructing RetryInfo instances.

Returns:

a new builder instance