SubscriptionArgs

data class SubscriptionArgs(val ackDeadlineSeconds: Output<Int>? = null, val name: Output<String>? = null, val pushConfig: Output<PushConfigArgs>? = null, val topic: Output<String>? = null) : ConvertibleToJava<SubscriptionArgs>

Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.

Constructors

Link copied to clipboard
fun SubscriptionArgs(ackDeadlineSeconds: Output<Int>? = null, name: Output<String>? = null, pushConfig: Output<PushConfigArgs>? = null, topic: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SubscriptionArgs

Properties

Link copied to clipboard
val ackDeadlineSeconds: Output<Int>? = null

For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis).

Link copied to clipboard
val name: Output<String>? = null

Name of the subscription.

Link copied to clipboard
val pushConfig: Output<PushConfigArgs>? = null

If push delivery is used with this subscription, this field is used to configure it.

Link copied to clipboard
val topic: Output<String>? = null

The name of the topic from which this subscription is receiving messages.