final case class RetryPolicy(minimumBackoff: Option[Duration] = _root_.scala.None, maximumBackoff: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[RetryPolicy] with Product with Serializable

A policy that specifies how 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.

minimumBackoff

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

maximumBackoff

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

Annotations
@SerialVersionUID()
Source
RetryPolicy.scala
Linear Supertypes
Updatable[RetryPolicy], GeneratedMessage, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RetryPolicy
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RetryPolicy(minimumBackoff: Option[Duration] = _root_.scala.None, maximumBackoff: Option[Duration] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    minimumBackoff

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

    maximumBackoff

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearMaximumBackoff: RetryPolicy
  6. def clearMinimumBackoff: RetryPolicy
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def companion: RetryPolicy.type
    Definition Classes
    RetryPolicy → GeneratedMessage
  9. def discardUnknownFields: RetryPolicy
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    RetryPolicy → GeneratedMessage
  13. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    RetryPolicy → GeneratedMessage
  14. def getMaximumBackoff: Duration
  15. def getMinimumBackoff: Duration
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val maximumBackoff: Option[Duration]
  18. val minimumBackoff: Option[Duration]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. def serializedSize: Int
    Definition Classes
    RetryPolicy → GeneratedMessage
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  26. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  27. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  28. def toProtoString: String
    Definition Classes
    RetryPolicy → GeneratedMessage
  29. val unknownFields: UnknownFieldSet
  30. def update(ms: (Lens[RetryPolicy, RetryPolicy]) => Mutation[RetryPolicy]*): RetryPolicy
    Definition Classes
    Updatable
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. def withMaximumBackoff(__v: Duration): RetryPolicy
  35. def withMinimumBackoff(__v: Duration): RetryPolicy
  36. def withUnknownFields(__v: UnknownFieldSet): RetryPolicy
  37. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  38. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    RetryPolicy → GeneratedMessage
  39. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Updatable[RetryPolicy]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped