final case class Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, bigqueryConfig: Option[BigQueryConfig] = _root_.scala.None, cloudStorageConfig: Option[CloudStorageConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, filter: String = "", deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, retryPolicy: Option[RetryPolicy] = _root_.scala.None, detached: Boolean = false, enableExactlyOnceDelivery: Boolean = false, topicMessageRetentionDuration: Option[Duration] = _root_.scala.None, state: State = com.google.pubsub.v1.pubsub.Subscription.State.STATE_UNSPECIFIED, analyticsHubSubscriptionInfo: Option[AnalyticsHubSubscriptionInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Subscription] with Product with Serializable
A subscription resource. If none of push_config
, bigquery_config
, or
cloud_storage_config
is set, then the subscriber will pull and ack messages
using API methods. At most one of these fields may be set.
- 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
Optional. If push delivery is used with this subscription, this field is used to configure it.
- bigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
- cloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
- ackDeadlineSeconds
Optional. 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 correspondingack_id
if using non-streaming pull or send theack_id
in aStreamingModifyAckDeadlineRequest
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
Optional. 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 [Seek
to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.- messageRetentionDuration
Optional. 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 aSeek
can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.- labels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
- enableMessageOrdering
Optional. If true, messages published with the same
ordering_key
inPubsubMessage
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.- expirationPolicy
Optional. 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* withttl
of 31 days will be used. The minimum allowed value forexpiration_policy.ttl
is 1 day. Ifexpiration_policy
is set, butexpiration_policy.ttl
is not set, the subscription never expires.- filter
Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only
PubsubMessage
s whoseattributes
field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.- deadLetterPolicy
Optional. 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 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.
- retryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
- detached
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog.
Pull
andStreamingPull
requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.- enableExactlyOnceDelivery
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of
message_id
on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenable_exactly_once_delivery
is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_id
values.- topicMessageRetentionDuration
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last
topic_message_retention_duration
are always available to subscribers. See themessage_retention_duration
field inTopic
. This field is set only in responses from the server; it is ignored if it is set in any requests.- state
Output only. An output-only field indicating whether or not the subscription can receive messages.
- analyticsHubSubscriptionInfo
Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.
- Annotations
- @SerialVersionUID()
- Source
- Subscription.scala
- Alphabetic
- By Inheritance
- Subscription
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Subscription(name: String = "", topic: String = "", pushConfig: Option[PushConfig] = _root_.scala.None, bigqueryConfig: Option[BigQueryConfig] = _root_.scala.None, cloudStorageConfig: Option[CloudStorageConfig] = _root_.scala.None, ackDeadlineSeconds: Int = 0, retainAckedMessages: Boolean = false, messageRetentionDuration: Option[Duration] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, enableMessageOrdering: Boolean = false, expirationPolicy: Option[ExpirationPolicy] = _root_.scala.None, filter: String = "", deadLetterPolicy: Option[DeadLetterPolicy] = _root_.scala.None, retryPolicy: Option[RetryPolicy] = _root_.scala.None, detached: Boolean = false, enableExactlyOnceDelivery: Boolean = false, topicMessageRetentionDuration: Option[Duration] = _root_.scala.None, state: State = com.google.pubsub.v1.pubsub.Subscription.State.STATE_UNSPECIFIED, analyticsHubSubscriptionInfo: Option[AnalyticsHubSubscriptionInfo] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)
- 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
Optional. If push delivery is used with this subscription, this field is used to configure it.
- bigqueryConfig
Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
- cloudStorageConfig
Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
- ackDeadlineSeconds
Optional. 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 correspondingack_id
if using non-streaming pull or send theack_id
in aStreamingModifyAckDeadlineRequest
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
Optional. 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 [Seek
to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages.- messageRetentionDuration
Optional. 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 aSeek
can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.- labels
Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels).
- enableMessageOrdering
Optional. If true, messages published with the same
ordering_key
inPubsubMessage
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.- expirationPolicy
Optional. 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* withttl
of 31 days will be used. The minimum allowed value forexpiration_policy.ttl
is 1 day. Ifexpiration_policy
is set, butexpiration_policy.ttl
is not set, the subscription never expires.- filter
Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only
PubsubMessage
s whoseattributes
field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.- deadLetterPolicy
Optional. 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 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.
- retryPolicy
Optional. A policy that specifies how Pub/Sub retries message delivery for this subscription. If not set, the default retry policy is applied. This generally implies that messages will be retried as soon as possible for healthy subscribers. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
- detached
Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog.
Pull
andStreamingPull
requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.- enableExactlyOnceDelivery
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of
message_id
on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message whenenable_exactly_once_delivery
is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinctmessage_id
values.- topicMessageRetentionDuration
Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last
topic_message_retention_duration
are always available to subscribers. See themessage_retention_duration
field inTopic
. This field is set only in responses from the server; it is ignored if it is set in any requests.- state
Output only. An output-only field indicating whether or not the subscription can receive messages.
- analyticsHubSubscriptionInfo
Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.
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
- val analyticsHubSubscriptionInfo: Option[AnalyticsHubSubscriptionInfo]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val bigqueryConfig: Option[BigQueryConfig]
- def clearAnalyticsHubSubscriptionInfo: Subscription
- def clearBigqueryConfig: Subscription
- def clearCloudStorageConfig: Subscription
- def clearDeadLetterPolicy: Subscription
- def clearExpirationPolicy: Subscription
- def clearLabels: Subscription
- def clearMessageRetentionDuration: Subscription
- def clearPushConfig: Subscription
- def clearRetryPolicy: Subscription
- def clearTopicMessageRetentionDuration: Subscription
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val cloudStorageConfig: Option[CloudStorageConfig]
- def companion: Subscription.type
- Definition Classes
- Subscription → GeneratedMessage
- val deadLetterPolicy: Option[DeadLetterPolicy]
- val detached: Boolean
- def discardUnknownFields: Subscription
- val enableExactlyOnceDelivery: Boolean
- val enableMessageOrdering: Boolean
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val expirationPolicy: Option[ExpirationPolicy]
- val filter: String
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getAnalyticsHubSubscriptionInfo: AnalyticsHubSubscriptionInfo
- def getBigqueryConfig: BigQueryConfig
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getCloudStorageConfig: CloudStorageConfig
- 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
- def getRetryPolicy: RetryPolicy
- def getTopicMessageRetentionDuration: Duration
- 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val pushConfig: Option[PushConfig]
- val retainAckedMessages: Boolean
- val retryPolicy: Option[RetryPolicy]
- def serializedSize: Int
- Definition Classes
- Subscription → GeneratedMessage
- val state: State
- 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 topicMessageRetentionDuration: Option[Duration]
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[Subscription, Subscription]) => Mutation[Subscription]*): Subscription
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withAckDeadlineSeconds(__v: Int): Subscription
- def withAnalyticsHubSubscriptionInfo(__v: AnalyticsHubSubscriptionInfo): Subscription
- def withBigqueryConfig(__v: BigQueryConfig): Subscription
- def withCloudStorageConfig(__v: CloudStorageConfig): Subscription
- def withDeadLetterPolicy(__v: DeadLetterPolicy): Subscription
- def withDetached(__v: Boolean): Subscription
- def withEnableExactlyOnceDelivery(__v: Boolean): Subscription
- def withEnableMessageOrdering(__v: Boolean): Subscription
- def withExpirationPolicy(__v: ExpirationPolicy): Subscription
- def withFilter(__v: String): 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 withRetryPolicy(__v: RetryPolicy): Subscription
- def withState(__v: State): Subscription
- def withTopic(__v: String): Subscription
- def withTopicMessageRetentionDuration(__v: Duration): 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