Cloud PubSub V1 Client - Class RetryPolicy (1.41.3)

Reference documentation and code samples for the Cloud PubSub V1 Client class RetryPolicy.

A policy that specifies how Cloud Pub/Sub retries message delivery.

Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.

Generated from protobuf message google.pubsub.v1.RetryPolicy

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ minimum_backoff Google\Protobuf\Duration

The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

↳ maximum_backoff Google\Protobuf\Duration

The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.

getMinimumBackoff

The minimum delay between consecutive deliveries of a given message.

Value should be between 0 and 600 seconds. Defaults to 10 seconds.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasMinimumBackoff

clearMinimumBackoff

setMinimumBackoff

The minimum delay between consecutive deliveries of a given message.

Value should be between 0 and 600 seconds. Defaults to 10 seconds.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getMaximumBackoff

The maximum delay between consecutive deliveries of a given message.

Value should be between 0 and 600 seconds. Defaults to 600 seconds.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasMaximumBackoff

clearMaximumBackoff

setMaximumBackoff

The maximum delay between consecutive deliveries of a given message.

Value should be between 0 and 600 seconds. Defaults to 600 seconds.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this