Enclosing class:

RetryPolicy

public static final class RetryPolicy.RetryPolicyBuilder
extends Object 

• Constructor Summary

  Constructors

  Constructor and Description
  RetryPolicyBuilder ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  RetryPolicy	build ()
  void	setBackoffStrategy (RetryPolicy.BackoffStrategy backoffStrategy)
  void	setFastFailRateLimiting (boolean fastFailRateLimiting)
  void	setHonorDefaultBackoffStrategyInRetryMode (boolean honorBackOffStrategyInRetryMode)
  void	setHonorDefaultMaxErrorRetryInRetryMode (boolean honorDefaultMaxErrorRetryInRetryMode)
  void	setHonorMaxErrorRetryInClientConfig (boolean honorMaxErrorRetryInClientConfig)
  void	setMaxErrorRetry (int maxErrorRetry)
  void	setRetryCondition (RetryPolicy.RetryCondition retryCondition)
  void	setRetryMode (RetryMode retryMode)
  RetryPolicy.RetryPolicyBuilder	withBackoffStrategy (RetryPolicy.BackoffStrategy backoffStrategy) Set the back-off strategy for controlling how long the next retry should wait.
  RetryPolicy.RetryPolicyBuilder	withFastFailRateLimiting (boolean fastFailRateLimiting) Whether the client should fail immediately when it cannot immediately make a request because there is not enough capacity in the rate limiter.
  RetryPolicy.RetryPolicyBuilder	withHonorDefaultBackoffStrategyInRetryMode (boolean honorBackOffStrategyInRetryMode) Whether the policy should honor the backoff strategy dictated by the configured retry mode.
  RetryPolicy.RetryPolicyBuilder	withHonorDefaultMaxErrorRetryInRetryMode (boolean honorDefaultMaxErrorRetryInRetryMode) Whether the policy should honor the max error retries dictated by the configured retry mode.
  RetryPolicy.RetryPolicyBuilder	withHonorMaxErrorRetryInClientConfig (boolean honorMaxErrorRetryInClientConfig) Set whether this retry policy should honor the max error retry set by ClientConfiguration.setMaxErrorRetry(int).
  RetryPolicy.RetryPolicyBuilder	withMaxErrorRetry (int maxErrorRetry) Set aximum number of retry attempts for failed requests.
  RetryPolicy.RetryPolicyBuilder	withRetryCondition (RetryPolicy.RetryCondition retryCondition) Set the retry condition on whether a specific request and exception should be retried.
  RetryPolicy.RetryPolicyBuilder	withRetryMode (RetryMode retryMode) Set the retry mode for the client.

  • Methods inherited from class java.lang.Object

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

• Constructor Detail

  • RetryPolicyBuilder

    public RetryPolicyBuilder()

• Method Detail

  • withRetryCondition

    public RetryPolicy.RetryPolicyBuilder withRetryCondition(RetryPolicy.RetryCondition retryCondition)

    Set the retry condition on whether a specific request and exception should be retried. If null value is specified, the SDK' *default retry condition is used.

    Parameters:

    retryCondition - The retry condition.

    Returns:

    This object for method chaining.

  • setRetryCondition

    public void setRetryCondition(RetryPolicy.RetryCondition retryCondition)

  • withBackoffStrategy

    public RetryPolicy.RetryPolicyBuilder withBackoffStrategy(RetryPolicy.BackoffStrategy backoffStrategy)

    Set the back-off strategy for controlling how long the next retry should wait. If null value is specified, the SDK' default exponential back-off strategy is used.

    Parameters:

    backoffStrategy - The backoff strategy.

    Returns:

    This object for method chaining.

  • setBackoffStrategy

    public void setBackoffStrategy(RetryPolicy.BackoffStrategy backoffStrategy)

  • withMaxErrorRetry

    public RetryPolicy.RetryPolicyBuilder withMaxErrorRetry(int maxErrorRetry)

    Set aximum number of retry attempts for failed requests.

    Parameters:

    maxErrorRetry - The max retry attempts.

    Returns:

    This object for method chaining.

  • setMaxErrorRetry

    public void setMaxErrorRetry(int maxErrorRetry)

  • withHonorMaxErrorRetryInClientConfig

    public RetryPolicy.RetryPolicyBuilder withHonorMaxErrorRetryInClientConfig(boolean honorMaxErrorRetryInClientConfig)

    Set whether this retry policy should honor the max error retry set by ClientConfiguration.setMaxErrorRetry(int).

    Parameters:

    honorMaxErrorRetryInClientConfig - Whether the policy should honor the max error retry setting on the client configuration.

    Returns:

    This object for method chaining.

  • setHonorMaxErrorRetryInClientConfig

    public void setHonorMaxErrorRetryInClientConfig(boolean honorMaxErrorRetryInClientConfig)

  • withRetryMode

    public RetryPolicy.RetryPolicyBuilder withRetryMode(RetryMode retryMode)

    Set the retry mode for the client.

    Parameters:

    retryMode - The retry mode.

    Returns:

    This object for method chaining.

  • setRetryMode

    public void setRetryMode(RetryMode retryMode)

  • withHonorDefaultMaxErrorRetryInRetryMode

    public RetryPolicy.RetryPolicyBuilder withHonorDefaultMaxErrorRetryInRetryMode(boolean honorDefaultMaxErrorRetryInRetryMode)

    Whether the policy should honor the max error retries dictated by the configured retry mode.

    Parameters:

    honorDefaultMaxErrorRetryInRetryMode - Whether the policy should honor the max error retries dictated by the configured retry mode.

    Returns:

    This object for method chaining.

  • setHonorDefaultMaxErrorRetryInRetryMode

    public void setHonorDefaultMaxErrorRetryInRetryMode(boolean honorDefaultMaxErrorRetryInRetryMode)

  • withFastFailRateLimiting

    public RetryPolicy.RetryPolicyBuilder withFastFailRateLimiting(boolean fastFailRateLimiting)

    Whether the client should fail immediately when it cannot immediately make a request because there is not enough capacity in the rate limiter.

    Note: This configuration only has an effect when used in combination with the RetryMode.ADAPTIVE retry mode.

    Parameters:

    fastFailRateLimiting - Whether to fail fast.

    Returns:

    This object for method chaining.

  • setFastFailRateLimiting

    public void setFastFailRateLimiting(boolean fastFailRateLimiting)

  • withHonorDefaultBackoffStrategyInRetryMode

    public RetryPolicy.RetryPolicyBuilder withHonorDefaultBackoffStrategyInRetryMode(boolean honorBackOffStrategyInRetryMode)

    Whether the policy should honor the backoff strategy dictated by the configured retry mode.

    Parameters:

    honorBackOffStrategyInRetryMode - Whether the policy should honor the backoff strategy dictated by the configured retry mode.

    Returns:

    This object for method chaining.

  • setHonorDefaultBackoffStrategyInRetryMode

    public void setHonorDefaultBackoffStrategyInRetryMode(boolean honorBackOffStrategyInRetryMode)

  • build

    public RetryPolicy build()