REST Resource: projects.subscriptions

Resource: Subscription

A subscription resource.

JSON representation 
{
  "name": string,
  "topic": string,
  "pushConfig": {
    object (PushConfig)
  },
  "ackDeadlineSeconds": number,
  "retainAckedMessages": boolean,
  "messageRetentionDuration": string,
  "labels": {
    string: string,
    ...
  },
  "expirationPolicy": {
    object (ExpirationPolicy)
  }
}
Fields
name

string

Name of the subscription. Format is projects/{project}/subscriptions/{sub}.

topic

string

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

object (PushConfig)

If push delivery is used with this subscription, this field is used to configure it. An empty pushConfig signifies that the subscriber will pull and ack messages using API methods.

ackDeadlineSeconds

number

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 subscriptions.modifyAckDeadline with the corresponding ackId if using non-streaming pull or send the ackId in a StreamingModifyAckDeadlineRequest 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

boolean

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 window. This must be true if you would like to subscriptions.seek to a timestamp.
messageRetentionDuration

string (Duration format)

How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If retainAckedMessages is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a subscriptions.seek can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
labels

map (key: string, value: string)

See Creating and managing labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
expirationPolicy

object (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 expirationPolicy is not set, a default policy with ttl of 31 days will be used. The minimum allowed value for expirationPolicy.ttl is 1 day.

PushConfig

Configuration for a push delivery endpoint.

JSON representation 
{
  "pushEndpoint": string,
  "attributes": {
    string: string,
    ...
  },
  "oidcToken": {
    object (OidcToken)
  }
}
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".

attributes

map (key: string, value: string)

Endpoint configuration attributes.

Every endpoint has a set of API supported attributes that can be used to control different aspects of the message delivery.

The currently supported attribute is x-goog-version, which you can use to change the format of the pushed message. This attribute indicates the version of the data expected by the endpoint. This controls the shape of the pushed message (i.e., its fields and metadata). The endpoint version is based on the version of the Pub/Sub API.

If not present during the subscriptions.create call, it will default to the version of the API used to make such call. If not present during a subscriptions.modifyPushConfig call, its value will not be changed. subscriptions.get calls will always return a valid version, even if the subscription was created without this attribute.

The possible values for this attribute are:

  • v1beta1: uses the push format defined in the v1beta1 Pub/Sub API.
  • v1 or v1beta2: uses the push format defined in the v1 Pub/Sub API.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
oidcToken

object (OidcToken)

If specified, Pub/Sub will generate and attach an OIDC JWT token as an Authorization header in the HTTP request for every pushed message.

OidcToken

Contains information needed for generating an OpenID Connect token.

JSON representation 
{
  "serviceAccountEmail": string,
  "audience": string
}
Fields
serviceAccountEmail

string

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

string

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

string (Duration format)

Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".

Methods

acknowledge

 Acknowledges the messages associated with the ack_ids in the AcknowledgeRequest.

create

 Creates a subscription to a given topic.

delete

 Deletes an existing subscription.

get

 Gets the configuration details of a subscription.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists matching subscriptions.

modifyAckDeadline

 Modifies the ack deadline for a specific message.

modifyPushConfig

 Modifies the PushConfig for a specified subscription.

patch

 Updates an existing subscription.

pull

 Pulls messages from the server.

seek

 Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.
Was this page helpful? Let us know how we did:

Send feedback about...

This page
Documentation feedback
Cloud Pub/Sub
Product feedback