final case class Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = None, labels: Map[String, String] = ...) extends GeneratedMessage with Message[Subscription] with Updatable[Subscription] with Product with Serializable

A subscription resource.

name

The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

topic

The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

pushConfig

If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.

ackDeadlineSeconds

This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

retainAckedMessages

Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the message_retention_duration window.

messageRetentionDuration

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

labels

User labels.

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

Instance Constructors

  1. new Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = None, labels: Map[String, String] = ...)

    name

    The name of the subscription. It must have the format "projects/{project}/subscriptions/{subscription}". {subscription} must start with a letter, and contain only letters ([A-Za-z]), numbers ([0-9]), dashes (-), underscores (_), periods (.), tildes (~), plus (+) or percent signs (%). It must be between 3 and 255 characters in length, and it must not start with "goog".

    topic

    The name of the topic from which this subscription is receiving messages. Format is projects/{project}/topics/{topic}. The value of this field will be _deleted-topic_ if the topic has been deleted.

    pushConfig

    If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.

    ackDeadlineSeconds

    This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call ModifyAckDeadline with the corresponding ack_id if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

    retainAckedMessages

    Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the message_retention_duration window.

    messageRetentionDuration

    How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retain_acked_messages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a Seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

    labels

    User labels.

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. val ackDeadlineSeconds: Int
  5. def addAllLabels(__vs: TraversableOnce[(String, String)]): Subscription
  6. def addLabels(__vs: (String, String)*): Subscription
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clearLabels: Subscription
  9. def clearMessageRetentionDuration: Subscription
  10. def clearPushConfig: Subscription
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  12. def companion: Subscription.type
    Definition Classes
    Subscription → GeneratedMessage
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Subscription → GeneratedMessage
  16. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Subscription → GeneratedMessage
  17. def getMessageRetentionDuration: Duration
  18. def getPushConfig: PushConfig
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val labels: Map[String, String]
  21. def mergeFrom(_input__: CodedInputStream): Subscription
    Definition Classes
    Subscription → Message
  22. val messageRetentionDuration: Option[Duration]
  23. val name: String
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. val pushConfig: Option[PushConfig]
  28. val retainAckedMessages: Boolean
  29. final def serializedSize: Int
    Definition Classes
    Subscription → GeneratedMessage
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  32. def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  33. def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  34. def toProtoString: String
    Definition Classes
    Subscription → GeneratedMessage
  35. val topic: String
  36. def update(ms: (Lens[Subscription, Subscription]) ⇒ Mutation[Subscription]*): Subscription
    Definition Classes
    Updatable
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withAckDeadlineSeconds(__v: Int): Subscription
  41. def withLabels(__v: Map[String, String]): Subscription
  42. def withMessageRetentionDuration(__v: Duration): Subscription
  43. def withName(__v: String): Subscription
  44. def withPushConfig(__v: PushConfig): Subscription
  45. def withRetainAckedMessages(__v: Boolean): Subscription
  46. def withTopic(__v: String): Subscription
  47. def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  48. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Subscription → GeneratedMessage
  49. def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def getAllFields: Map[FieldDescriptor, Any]
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use toPMessage

  3. def getField(field: FieldDescriptor): Any
    Definition Classes
    GeneratedMessage
    Annotations
    @deprecated
    Deprecated

    (Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Inherited from Product

Inherited from Equals

Inherited from Updatable[Subscription]

Inherited from Message[Subscription]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped