REST Resource: subscriptions

Resource: Subscription

A subscription resource.

JSON representation 
{
  "name": string,
  "topic": string,
  "pushConfig": {
    object (PushConfig)
  },
  "ackDeadlineSeconds": integer
}
Fields
name

string

Name of the subscription.
topic

string

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

object (PushConfig)

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

integer

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 ackId with

subscriptions.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).

PushConfig

Configuration for a push delivery endpoint.

JSON representation 
{
  "pushEndpoint": string
}
Fields
pushEndpoint

string

A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push".

Methods

acknowledge

 The method tech.pubsub.SubscriberService.Acknowledge is not available in this universe.

create

 The method tech.pubsub.SubscriberService.CreateSubscription is not available in this universe.

delete

 The method tech.pubsub.SubscriberService.DeleteSubscription is not available in this universe.

get

 The method tech.pubsub.SubscriberService.GetSubscription is not available in this universe.

list

 The method tech.pubsub.SubscriberService.ListSubscriptions is not available in this universe.

modifyAckDeadline

 The method tech.pubsub.SubscriberService.ModifyAckDeadline is not available in this universe.

modifyPushConfig

 The method tech.pubsub.SubscriberService.ModifyPushConfig is not available in this universe.

pull

 The method tech.pubsub.SubscriberService.Pull is not available in this universe.

pullBatch

 The method tech.pubsub.SubscriberService.PullBatch is not available in this universe.