Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update RetrySettings javadocs to include polling #1863

Merged
merged 6 commits into from
Nov 6, 2023
Merged

docs: Update RetrySettings javadocs to include polling #1863

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ea94a9b
docs: Update RetrySettings to include LRO defaults
lqiu96 Jul 18, 2023
bc419f7
docs: Add poll verbiage to the docs
lqiu96 Jul 18, 2023
5df40ae
docs: Add info about Zero RPC timeout
lqiu96 Jul 18, 2023
1f74b23
Merge branch 'main' into update_retrysettings_javadoc
lqiu96 Nov 1, 2023
1497346
docs: Update docs per PR feedback
lqiu96 Nov 1, 2023
86bd288
docs: Update docs per PR feedback
lqiu96 Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: Add poll verbiage to the docs
  • Loading branch information
@lqiu96
lqiu96 committed Jul 18, 2023
commit bc419f7ae970458672d025ddeb5ae63a392b1af6
42 changes: 21 additions & 21 deletions gax-java/gax/src/main/java/com/google/api/gax/retrying/RetrySettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ public abstract class RetrySettings implements Serializable {

/**
* TotalTimeout has ultimate control over how long the logic should keep trying the remote call
* until it gives up completely. The higher the total timeout, the more retries can be attempted.
* The default value is {@code Duration.ZERO}.
* until it gives up completely. The higher the total timeout, the more retries and polls can be
* attempted. The default value is {@code Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default timeout value set above and LROs
* have a default total timeout value of {@code Duration.ofMillis(300000)} (5 minutes).
*/
public abstract Duration getTotalTimeout();

/**
* InitialRetryDelay controls the delay before the first retry. Subsequent retries will use this
* value adjusted according to the RetryDelayMultiplier. The default value is {@code
* InitialRetryDelay controls the delay before the first retry/ poll. Subsequent retries and polls
* will use this value adjusted according to the RetryDelayMultiplier. The default value is {@code
blakeli0 marked this conversation as resolved.
Show resolved Hide resolved
* Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default initial retry delay value set above
Expand All @@ -98,9 +98,9 @@ public abstract class RetrySettings implements Serializable {
public abstract Duration getInitialRetryDelay();

/**
* RetryDelayMultiplier controls the change in retry delay. The retry delay of the previous call
* is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call. The
* default value is {@code 1.0}.
* RetryDelayMultiplier controls the change in delay before the next retry or poll. The retry
* delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry
* delay for the next call. The default value is {@code 1.0}.
*
* <p>If there are no configurations, Retries have the default retry delay multiplier value set
* above and LROs have a default retry delay multiplier of {@code 1.5}.
Expand Down Expand Up @@ -196,7 +196,7 @@ public abstract static class Builder {

/**
* TotalTimeout has ultimate control over how long the logic should keep trying the remote call
* until it gives up completely. The higher the total timeout, the more retries can be
* until it gives up completely. The higher the total timeout, the more retries and polls can be
* attempted. The default value is {@code Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default timeout value set above and LROs
Expand All @@ -205,9 +205,9 @@ public abstract static class Builder {
public abstract Builder setTotalTimeout(Duration totalTimeout);

/**
* InitialRetryDelay controls the delay before the first retry. Subsequent retries will use this
* value adjusted according to the RetryDelayMultiplier. The default value is {@code
* Duration.ZERO}.
* InitialRetryDelay controls the delay before the first retry/ poll. Subsequent retries and
* polls will use this value adjusted according to the RetryDelayMultiplier. The default value
* is {@code Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default initial retry delay value set
* above and LROs have a default initial poll delay value of {@code Duration.ofMillis(5000)} (5
Expand All @@ -216,9 +216,9 @@ public abstract static class Builder {
public abstract Builder setInitialRetryDelay(Duration initialDelay);

/**
* RetryDelayMultiplier controls the change in retry delay. The retry delay of the previous call
* is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call. The
* default value is {@code 1.0}.
* RetryDelayMultiplier controls the change in delay before the next retry or poll. The retry
* delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry
* delay for the next call. The default value is {@code 1.0}.
*
* <p>If there are no configurations, Retries have the default retry delay multiplier value set
* above and LROs have a default retry delay multiplier of {@code 1.5}.
Expand Down Expand Up @@ -291,7 +291,7 @@ public abstract static class Builder {

/**
* TotalTimeout has ultimate control over how long the logic should keep trying the remote call
* until it gives up completely. The higher the total timeout, the more retries can be
* until it gives up completely. The higher the total timeout, the more retries and polls can be
* attempted. The default value is {@code Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default timeout value set above and LROs
Expand All @@ -300,9 +300,9 @@ public abstract static class Builder {
public abstract Duration getTotalTimeout();

/**
* InitialRetryDelay controls the delay before the first retry. Subsequent retries will use this
* value adjusted according to the RetryDelayMultiplier. The default value is {@code
* Duration.ZERO}.
* InitialRetryDelay controls the delay before the first retry/ poll. Subsequent retries and
* polls will use this value adjusted according to the RetryDelayMultiplier. The default value
* is {@code Duration.ZERO}.
*
* <p>If there are no configurations, Retries have the default initial retry delay value set
* above and LROs have a default initial poll delay value of {@code Duration.ofMillis(5000)} (5
Expand All @@ -311,9 +311,9 @@ public abstract static class Builder {
public abstract Duration getInitialRetryDelay();

/**
* RetryDelayMultiplier controls the change in retry delay. The retry delay of the previous call
* is multiplied by the RetryDelayMultiplier to calculate the retry delay for the next call. The
* default value is {@code 1.0}.
* RetryDelayMultiplier controls the change in delay before the next retry or poll. The retry
* delay of the previous call is multiplied by the RetryDelayMultiplier to calculate the retry
* delay for the next call. The default value is {@code 1.0}.
*
* <p>If there are no configurations, Retries have the default retry delay multiplier value set
* above and LROs have a default retry delay multiplier of {@code 1.5}.
Expand Down