Method: projects.subscriptions.patch

Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.

HTTP request


Path parameters

Parameters
subscription.name

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "subscription": {
    "name": string,
    "topic": string,
    "pushConfig": {
      "pushEndpoint": string,
      "attributes": {
        string: string,
        ...
      },

      // Union field authentication_method can be only one of the following:
      "oidcToken": {
        object (OidcToken)
      }
      // End of list of possible types for union field authentication_method.,

      // Union field wrapper can be only one of the following:
      "pubsubWrapper": {
        object (PubsubWrapper)
      },
      "noWrapper": {
        object (NoWrapper)
      }
      // End of list of possible types for union field wrapper.
    },
    "bigqueryConfig": {
      "table": string,
      "useTopicSchema": boolean,
      "writeMetadata": boolean,
      "dropUnknownFields": boolean,
      "state": enum (State),
      "useTableSchema": boolean,
      "serviceAccountEmail": string
    },
    "cloudStorageConfig": {
      "bucket": string,
      "filenamePrefix": string,
      "filenameSuffix": string,
      "filenameDatetimeFormat": string,
      "maxDuration": string,
      "maxBytes": string,
      "maxMessages": string,
      "state": enum (State),
      "serviceAccountEmail": string,

      // Union field output_format can be only one of the following:
      "textConfig": {
        object (TextConfig)
      },
      "avroConfig": {
        object (AvroConfig)
      }
      // End of list of possible types for union field output_format.
    },
    "ackDeadlineSeconds": integer,
    "retainAckedMessages": boolean,
    "messageRetentionDuration": string,
    "labels": {
      string: string,
      ...
    },
    "enableMessageOrdering": boolean,
    "expirationPolicy": {
      "ttl": string
    },
    "filter": string,
    "deadLetterPolicy": {
      "deadLetterTopic": string,
      "maxDeliveryAttempts": integer
    },
    "retryPolicy": {
      "minimumBackoff": string,
      "maximumBackoff": string
    },
    "detached": boolean,
    "enableExactlyOnceDelivery": boolean,
    "topicMessageRetentionDuration": string,
    "state": enum (State),
    "analyticsHubSubscriptionInfo": {
      "listing": string,
      "subscription": string
    }
  },
  "updateMask": string
}
Fields
subscription.topic

string

Required. 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.
subscription.pushConfig

object (PushConfig)

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

object (BigQueryConfig)

Optional. If delivery to BigQuery is used with this subscription, this field is used to configure it.
subscription.cloudStorageConfig

object (CloudStorageConfig)

Optional. If delivery to Google Cloud Storage is used with this subscription, this field is used to configure it.
subscription.ackDeadlineSeconds

integer

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 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.
subscription.retainAckedMessages

boolean

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 window. This must be true if you would like to subscriptions.seek to a timestamp in the past to replay previously-acknowledged messages.
subscription.messageRetentionDuration

string (Duration format)

Optional. 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 31 days or less than 10 minutes.

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

map (key: string, value: string)

Optional. See Creating and managing labels.

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

boolean

Optional. If true, messages published with the same orderingKey in PubsubMessage will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order.
subscription.expirationPolicy

object (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 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. If expirationPolicy is set, but expirationPolicy.ttl is not set, the subscription never expires.
subscription.filter

string

Optional. An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
subscription.deadLetterPolicy

object (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.
subscription.retryPolicy

object (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.
subscription.detached

boolean

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. subscriptions.pull and StreamingPull requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made.
subscription.enableExactlyOnceDelivery

boolean

Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of messageId on this subscription:

  • The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires.
  • An acknowledged message will not be resent to a subscriber.

Note that subscribers may still receive multiple copies of a message when enableExactlyOnceDelivery is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct messageId values.
subscription.topicMessageRetentionDuration

string (Duration format)

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 topicMessageRetentionDuration are always available to subscribers. See the messageRetentionDuration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
subscription.state

enum (State)

Output only. An output-only field indicating whether or not the subscription can receive messages.
subscription.analyticsHubSubscriptionInfo

object (AnalyticsHubSubscriptionInfo)

Output only. Information about the associated Analytics Hub subscription. Only set if the subscritpion is created by Analytics Hub.
updateMask

string (FieldMask format)

Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Response body

If successful, the response body contains an 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.