Class TimedAttemptSettings (2.51.0)

Version 2.51.0

• 2.59.0 (latest)
• 2.58.0
• 2.57.0
• 2.55.0
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

public abstract class TimedAttemptSettings

Timed attempt execution settings. Defines time-specific properties of a retry attempt.

Inheritance

java.lang.Object > TimedAttemptSettings

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static TimedAttemptSettings.Builder newBuilder()

Returns
Type	Description
TimedAttemptSettings.Builder

Constructors

TimedAttemptSettings()

public TimedAttemptSettings()

Methods

getAttemptCount()

public abstract int getAttemptCount()

The attempt count. It is a zero-based value (first attempt will have this value set to 0). For streamed RPCs this will be reset after every successful message.

Returns
Type	Description
int

getFirstAttemptStartTimeNanos()

public abstract long getFirstAttemptStartTimeNanos()

The start time of the first attempt. Note that this value is dependent on the actual ApiClock used during the process.

Returns
Type	Description
long

getGlobalSettings()

public abstract RetrySettings getGlobalSettings()

Returns global (attempt-independent) retry settings.

Returns
Type	Description
RetrySettings

getOverallAttemptCount()

public abstract int getOverallAttemptCount()

The overall attempt count. It is a zero-based value (first attempt will have this value set to 0). This will be the sum of all attempt counts for a streaming RPC and will be equal to #getAttemptCount() for unary RPCs.

Returns
Type	Description
int

getRandomizedRetryDelay()

public final Duration getRandomizedRetryDelay()

Obsolete

Use getRandomizedRetryDelayDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getRandomizedRetryDelayDuration() instead

Returns
Type	Description
org.threeten.bp.Duration

getRandomizedRetryDelayDuration()

public abstract Duration getRandomizedRetryDelayDuration()

Returns randomized attempt delay. By default this value is calculated based on the retryDelay value, and is used as the actual attempt execution delay.

Returns
Type	Description
Duration

getRetryDelay()

public final Duration getRetryDelay()

Obsolete

Use getRetryDelayDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getRetryDelayDuration() instead

Returns
Type	Description
org.threeten.bp.Duration

getRetryDelayDuration()

public abstract Duration getRetryDelayDuration()

Returns the calculated retry delay. Note that the actual delay used for retry scheduling may be different (randomized, based on this value).

Returns
Type	Description
Duration

getRpcTimeout()

public final Duration getRpcTimeout()

Obsolete

Use getRpcTimeoutDuration() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use #getRpcTimeoutDuration() instead

Returns
Type	Description
org.threeten.bp.Duration

getRpcTimeoutDuration()

public abstract Duration getRpcTimeoutDuration()

Returns rpc timeout used for this attempt.

Returns
Type	Description
Duration

toBuilder()

public abstract TimedAttemptSettings.Builder toBuilder()

Returns
Type	Description
TimedAttemptSettings.Builder