Resource: Subscription
A subscription resource.
JSON representation | |
---|---|
{ "name": string, "topic": string, "pushConfig": { object ( |
Fields | |
---|---|
name |
Required. Name of the subscription. Format is |
topic |
Required. The name of the topic from which this subscription is receiving messages. Format is |
pushConfig |
If push delivery is used with this subscription, this field is used to configure it. An empty |
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 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 |
messageRetentionDuration |
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, terminated by ' |
labels |
See Creating and managing labels. An object containing a list of |
enableMessageOrdering |
If true, messages published with the same |
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 |
filter |
An expression written in the Pub/Sub filter language. If non-empty, then only |
deadLetterPolicy |
A policy that specifies the conditions for dead lettering messages in this subscription. If deadLetterPolicy 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 subscriptions.acknowledge() messages on this subscription. |
retryPolicy |
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 |
Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. |
PushConfig
Configuration for a push delivery endpoint.
JSON representation | |
---|---|
{
"pushEndpoint": string,
"attributes": {
string: string,
...
},
"oidcToken": {
object ( |
Fields | |
---|---|
pushEndpoint |
A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use |
attributes |
Endpoint configuration attributes that can be used to control different aspects of the message delivery. The only currently supported attribute is If not present during the The only supported values for the For example:
An object containing a list of |
oidcToken |
If specified, Pub/Sub will generate and attach an OIDC JWT token as an |
OidcToken
Contains information needed for generating an OpenID Connect token.
JSON representation | |
---|---|
{ "serviceAccountEmail": string, "audience": string } |
Fields | |
---|---|
serviceAccountEmail |
Service account email to be used for generating the OIDC token. The caller (for subscriptions.create, subscriptions.patch, and subscriptions.modifyPushConfig RPCs) must have the iam.serviceAccounts.actAs permission for the service account. |
audience |
Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for. The audience value is a single case-sensitive string. Having multiple values (array) for the audience field is not supported. More info about the OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not specified, the Push endpoint URL will be used. |
ExpirationPolicy
A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
JSON representation | |
---|---|
{ "ttl": string } |
Fields | |
---|---|
ttl |
Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of A duration in seconds with up to nine fractional digits, terminated by ' |
DeadLetterPolicy
Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times.
If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
JSON representation | |
---|---|
{ "deadLetterTopic": string, "maxDeliveryAttempts": integer } |
Fields | |
---|---|
deadLetterTopic |
The name of the topic to which dead letter messages should be published. Format is The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. |
maxDeliveryAttempts |
The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to subscriptions.modifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. |
RetryPolicy
A policy that specifies how Cloud Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
JSON representation | |
---|---|
{ "minimumBackoff": string, "maximumBackoff": string } |
Fields | |
---|---|
minimumBackoff |
The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. A duration in seconds with up to nine fractional digits, terminated by ' |
maximumBackoff |
The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. A duration in seconds with up to nine fractional digits, terminated by ' |
Methods |
|
---|---|
|
Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest . |
|
Creates a subscription to a given topic. |
|
Deletes an existing subscription. |
|
Detaches a subscription from this topic. |
|
Gets the configuration details of a subscription. |
|
Gets the access control policy for a resource. |
|
Lists matching subscriptions. |
|
Modifies the ack deadline for a specific message. |
|
Modifies the PushConfig for a specified subscription. |
|
Updates an existing subscription. |
|
Pulls messages from the server. |
|
Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |