Reference documentation and code samples for the Google Cloud Eventarc V1 Client class RetryPolicy.
The retry policy configuration for the Pipeline. The pipeline exponentially backs off in case the destination is non responsive or returns a retryable error code. The default semantics are as follows: The backoff starts with a 5 second delay and doubles the delay after each failed attempt (10 seconds, 20 seconds, 40 seconds, etc.).
The delay is capped at 60 seconds by default. Please note that if you set the min_retry_delay and max_retry_delay fields to the same value this will make the duration between retries constant.
Generated from protobuf message google.cloud.eventarc.v1.Pipeline.RetryPolicy
Namespace
Google \ Cloud \ Eventarc \ V1 \ PipelineMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_attempts |
int
Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5. |
↳ min_retry_delay |
Google\Protobuf\Duration
Optional. The minimum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 5. |
↳ max_retry_delay |
Google\Protobuf\Duration
Optional. The maximum amount of seconds to wait between retry attempts. The value must be between 1 and 600. The default value for this field is 60. |
getMaxAttempts
Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
| Returns | |
|---|---|
| Type | Description |
int |
|
setMaxAttempts
Optional. The maximum number of delivery attempts for any message. The value must be between 1 and 100. The default value for this field is 5.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinRetryDelay
Optional. The minimum amount of seconds to wait between retry attempts.
The value must be between 1 and 600. The default value for this field is 5.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasMinRetryDelay
clearMinRetryDelay
setMinRetryDelay
Optional. The minimum amount of seconds to wait between retry attempts.
The value must be between 1 and 600. The default value for this field is 5.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxRetryDelay
Optional. The maximum amount of seconds to wait between retry attempts.
The value must be between 1 and 600. The default value for this field is 60.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasMaxRetryDelay
clearMaxRetryDelay
setMaxRetryDelay
Optional. The maximum amount of seconds to wait between retry attempts.
The value must be between 1 and 600. The default value for this field is 60.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|