Class: Google::Apis::PubsubV1::RetryPolicy

Inherits:

Object

• Object
• Google::Apis::PubsubV1::RetryPolicy

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/pubsub_v1/classes.rb,
lib/google/apis/pubsub_v1/representations.rb,
lib/google/apis/pubsub_v1/representations.rb

Overview

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.

Instance Attribute Summary

• #maximum_backoff ⇒ String

  The maximum delay between consecutive deliveries of a given message.

• #minimum_backoff ⇒ String

  The minimum delay between consecutive deliveries of a given message.

Instance Method Summary

• #initialize(**args) ⇒ RetryPolicy constructor

  A new instance of RetryPolicy.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ RetryPolicy

Returns a new instance of RetryPolicy.

# File 'lib/google/apis/pubsub_v1/classes.rb', line 1176

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#maximum_backoff ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/pubsub_v1/classes.rb', line 1168

def maximum_backoff
  @maximum_backoff
end

#minimum_backoff ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/pubsub_v1/classes.rb', line 1174

def minimum_backoff
  @minimum_backoff
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/pubsub_v1/classes.rb', line 1181

def update!(**args)
  @maximum_backoff = args[:maximum_backoff] if args.key?(:maximum_backoff)
  @minimum_backoff = args[:minimum_backoff] if args.key?(:minimum_backoff)
end