Creates a subscription to a given topic. See the resource name rules. 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, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.
HTTP request
Path parameters
Parameters | |
---|---|
name |
Required. Name of the subscription. Format is |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "topic": string, "pushConfig": { object ( |
Fields | |
---|---|
topic |
Required. The name of the topic from which this subscription is receiving messages. Format is |
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 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 |
messageRetentionDuration |
Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If A duration in seconds with up to nine fractional digits, ending with ' |
labels |
Optional. See Creating and managing labels. An object containing a list of |
enableMessageOrdering |
Optional. If true, messages published with the same |
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 |
filter |
Optional. An expression written in the Pub/Sub filter language. If non-empty, then only |
deadLetterPolicy |
Optional. A policy that specifies the conditions for dead lettering messages in this subscription. If deadLetterPolicy 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 subscriptions.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. |
enableExactlyOnceDelivery |
Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of
Note that subscribers may still receive multiple copies of a message when |
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 A duration in seconds with up to nine fractional digits, ending with ' |
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. |
Response body
If successful, the response body contains a newly created instance of Subscription
.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.