Subscription

Companion object Subscription

final case class Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = ..., enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Subscription] with Product with Serializable

A subscription resource.

name: Required. 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: Required. 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: The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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. This must be true if you would like to <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>.
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: See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
enableMessageOrdering: If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
expirationPolicy: A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a *default policy* with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day.
deadLetterPolicy: A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Annotations: @SerialVersionUID()
Source: Subscription.scala

Linear Supertypes

Product, Equals, Updatable[Subscription], GeneratedMessage, Serializable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Subscription
Product
Equals
Updatable
GeneratedMessage
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = ..., enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, unknownFields: UnknownFieldSet = ...)
name
Required. 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
Required. 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
The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be outstanding. During that time period, the message will not be redelivered (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 non-streaming pull or send the ack_id in a StreamingModifyAckDeadlineRequest if using streaming 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. This must be true if you would like to <a href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time"> Seek to a timestamp</a>.
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
See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>.
enableMessageOrdering
If true, messages published with the same ordering_key in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.
expirationPolicy
A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If expiration_policy is not set, a *default policy* with ttl of 31 days will be used. The minimum allowed value for expiration_policy.ttl is 1 day.
deadLetterPolicy
A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. EXPERIMENTAL: This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val ackDeadlineSeconds: Int
def addAllLabels(__vs: Iterable[(String, String)]): Subscription
def addLabels(__vs: (String, String)*): Subscription
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearDeadLetterPolicy: Subscription
def clearExpirationPolicy: Subscription
def clearLabels: Subscription
def clearMessageRetentionDuration: Subscription
def clearPushConfig: Subscription
def clone(): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( ... ) @native() @HotSpotIntrinsicCandidate()
def companion: Subscription.type

Definition Classes
Subscription → GeneratedMessage
val deadLetterPolicy: Option[DeadLetterPolicy]
def discardUnknownFields: Subscription
val enableMessageOrdering: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val expirationPolicy: Option[ExpirationPolicy]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def getDeadLetterPolicy: DeadLetterPolicy
def getExpirationPolicy: ExpirationPolicy
def getField(__field: FieldDescriptor): PValue

Definition Classes
Subscription → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
Subscription → GeneratedMessage
def getMessageRetentionDuration: Duration
def getPushConfig: PushConfig
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val labels: Map[String, String]
val messageRetentionDuration: Option[Duration]
val name: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
val pushConfig: Option[PushConfig]
val retainAckedMessages: Boolean
def serializedSize: Int

Definition Classes
Subscription → GeneratedMessage
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
final def toByteString: ByteString

Definition Classes
GeneratedMessage
final def toPMessage: PMessage

Definition Classes
GeneratedMessage
def toProtoString: String

Definition Classes
Subscription → GeneratedMessage
val topic: String
val unknownFields: UnknownFieldSet
def update(ms: (Lens[Subscription, Subscription]) ⇒ Mutation[Subscription]*): Subscription

Definition Classes
Updatable
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... ) @native()
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withAckDeadlineSeconds(__v: Int): Subscription
def withDeadLetterPolicy(__v: DeadLetterPolicy): Subscription
def withEnableMessageOrdering(__v: Boolean): Subscription
def withExpirationPolicy(__v: ExpirationPolicy): Subscription
def withLabels(__v: Map[String, String]): Subscription
def withMessageRetentionDuration(__v: Duration): Subscription
def withName(__v: String): Subscription
def withPushConfig(__v: PushConfig): Subscription
def withRetainAckedMessages(__v: Boolean): Subscription
def withTopic(__v: String): Subscription
def withUnknownFields(__v: UnknownFieldSet): Subscription
final def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
Subscription → GeneratedMessage
final def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def finalize(): Unit

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
Deprecated
(Since version ) see corresponding Javadoc for more information.

Packages

Subscription

Companion object Subscription

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Product

Inherited from Equals

Inherited from Updatable[Subscription]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Subscription 

Companion object Subscription

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Product

Inherited from Equals

Inherited from Updatable[Subscription]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Subscription