OperationTimedPollAlgorithm (gax 2.19.5 API)

java.lang.Object
- com.google.api.gax.retrying.ExponentialRetryAlgorithm
- - com.google.api.gax.longrunning.OperationTimedPollAlgorithm

All Implemented Interfaces:

TimedRetryAlgorithm, TimedRetryAlgorithmWithContext
```
public class OperationTimedPollAlgorithm
extends ExponentialRetryAlgorithm
```
Operation timed polling algorithm, which uses exponential backoff factor for determining when the next polling operation should be executed. If the polling exceeds the total timeout this algorithm cancels polling.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OperationTimedPollAlgorithm`	`create(RetrySettings globalSettings)`	Creates the polling algorithm, using the default `NanoClock` for time computations.
`static OperationTimedPollAlgorithm`	`create(RetrySettings globalSettings, com.google.api.core.ApiClock clock)`
`boolean`	`shouldRetry(TimedAttemptSettings nextAttemptSettings)`	Returns `true` if another poll operation should be made or throws `CancellationException` otherwise.

Methods inherited from class com.google.api.gax.retrying.ExponentialRetryAlgorithm
createFirstAttempt, createFirstAttempt, createNextAttempt, createNextAttempt, nextRandomLong, shouldRetry

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static OperationTimedPollAlgorithm create(RetrySettings globalSettings)
```
    Creates the polling algorithm, using the default NanoClock for time computations.
    
    Parameters:
    
    globalSettings - the settings
    
    Returns:
    
    timed poll algorithm
  - create
```
public static OperationTimedPollAlgorithm create(RetrySettings globalSettings,
                                                 com.google.api.core.ApiClock clock)
```
  - shouldRetry
```
public boolean shouldRetry(TimedAttemptSettings nextAttemptSettings)
                    throws java.util.concurrent.CancellationException
```
    Returns true if another poll operation should be made or throws CancellationException otherwise.
    
    Specified by:
    
    shouldRetry in interface TimedRetryAlgorithm
    
    Overrides:
    
    shouldRetry in class ExponentialRetryAlgorithm
    
    Parameters:
    
    nextAttemptSettings - attempt settings, which will be used for the next attempt, if accepted
    
    Returns:
    
    true if more attempts should be made, never returns false (throws CancellationException instead)
    
    Throws:
    
    java.util.concurrent.CancellationException - if no more attempts should be made