RetryPolicy.Builder
@ExperimentalRetryPolicy
class RetryPolicy.Builder
A builder class for customizing RetryPolicy behavior.
Use the Builder to modify existing RetryPolicy instances, typically starting with the predefined options like DEFAULT or RETRY_UNAVAILABLE_CAMERA. The most common use is to set a custom timeout.
Example: Create a policy based on DEFAULT with a 10-second timeout:
new RetryPolicy.Builder(RetryPolicy.DEFAULT).setTimeoutInMillis(10000L).build()
Summary
Public constructors |
|---|
Builder(basePolicy: RetryPolicy)Creates a builder based on an existing |
Public functions |
|
|---|---|
RetryPolicy |
build()Creates the customized |
RetryPolicy.Builder |
setTimeoutInMillis(timeoutInMillis: Long)Sets a timeout in milliseconds. |
Public constructors
Builder
Builder(basePolicy: RetryPolicy)
Creates a builder based on an existing RetryPolicy.
This allows you to start with a predefined policy and add further customizations. For example, set a timeout to prevent retries from continuing endlessly.
| Parameters | |
|---|---|
basePolicy: RetryPolicy |
The RetryPolicy to use as a starting point. |
Public functions
build
fun build(): RetryPolicy
Creates the customized RetryPolicy instance.
| Returns | |
|---|---|
RetryPolicy |
The new |
setTimeoutInMillis
fun setTimeoutInMillis(timeoutInMillis: Long): RetryPolicy.Builder
Sets a timeout in milliseconds. If retries exceed this duration, they will be terminated with NOT_RETRY.
| Parameters | |
|---|---|
timeoutInMillis: Long |
The maximum duration for retries in milliseconds. A value of 0 indicates no timeout. |
| Returns | |
|---|---|
RetryPolicy.Builder |
|