docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html
index a3fb4c8..36216c6 100644
--- a/docs/dyn/pubsub_v1.projects.subscriptions.html
+++ b/docs/dyn/pubsub_v1.projects.subscriptions.html
@@ -187,76 +187,165 @@
The object takes the form of:
{ # A subscription resource.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
+ "pushConfig": { # Configuration for a push delivery endpoint. # 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.
+ "attributes": { # Endpoint configuration attributes that can be used to control different
+ # aspects of the message delivery.
+ #
+ # The only 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).
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the Pub/Sub API used to make such call. If not present in a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The only supported values for the `x-goog-version` 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.
+ #
+ # For example:
+ # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
"a_key": "A String",
},
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use `https://example.com/push`.
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A 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.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
},
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy is not set, dead lettering
- # is disabled.
- #
- # The Cloud Pub/Sub service account associated with this subscriptions's
- # parent project (i.e.,
+ },
+ "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
+ # then only `PubsubMessage`s whose `attributes` field matches the filter are
+ # delivered on this subscription. If empty, then no messages are filtered
+ # out.
+ # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+ # API might be changed in backward-incompatible ways and is not recommended
+ # for production use. It is not subject to any SLA or deprecation policy.
+ "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using
+ # non-streaming pull or send the `ack_id` 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.
+ "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
+ # from the moment a message is published.
+ # If `retain_acked_messages` is true, then this also configures the retention
+ # of acknowledged messages, and thus configures how far back in time a `Seek`
+ # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
+ # minutes.
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
# service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Acknowledge() messages on this subscription.
- # dead lettered multiple times.
+ # permission to Publish() to this topic.
#
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
+ # 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": 42, # 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 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.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
"pushConfig": { # Configuration for a push delivery endpoint. # 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.
@@ -314,7 +403,7 @@
# interval after the message is delivered and before it is acknowledged, it
# is considered to be <i>outstanding</i>. 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
# `ModifyAckDeadline` with the corresponding `ack_id` if using
@@ -323,10 +412,10 @@
# 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.
"messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
@@ -335,166 +424,77 @@
# of acknowledged messages, and thus configures how far back in time a `Seek`
# can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
# minutes.
- }
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
- "a_key": "A String",
- },
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
- },
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy is not set, dead lettering
- # is disabled.
- #
- # The Cloud Pub/Sub service account associated with this subscriptions's
- # parent project (i.e.,
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
# service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Acknowledge() messages on this subscription.
- # dead lettered multiple times.
+ # permission to Publish() to this topic.
#
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
- "pushConfig": { # Configuration for a push delivery endpoint. # 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.
- "attributes": { # Endpoint configuration attributes that can be used to control different
- # aspects of the message delivery.
- #
- # The only 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).
- #
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the Pub/Sub API used to make such call. If not present in a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
- #
- # The only supported values for the `x-goog-version` 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.
- #
- # For example:
- # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
- "a_key": "A String",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use `https://example.com/push`.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A 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.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
- # then only `PubsubMessage`s whose `attributes` field matches the filter are
- # delivered on this subscription. If empty, then no messages are filtered
- # out.
- # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
- # API might be changed in backward-incompatible ways and is not recommended
- # for production use. It is not subject to any SLA or deprecation policy.
- "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. During that time period, the
- # message will not be redelivered (on a best-effort basis).
+ # 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": 42, # The maximum number of delivery attempts for any message. The value must be
+ # between 5 and 100.
#
- # For pull subscriptions, this value is used as the initial value for the ack
- # deadline. To override this value for a given message, call
- # `ModifyAckDeadline` with the corresponding `ack_id` if using
- # non-streaming pull or send the `ack_id` 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.
+ # 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).
#
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
+ # A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
+ # client libraries may automatically extend ack_deadlines.
#
- # If the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
- "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
- # from the moment a message is published.
- # If `retain_acked_messages` is true, then this also configures the retention
- # of acknowledged messages, and thus configures how far back in time a `Seek`
- # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
- # minutes.
- }</pre>
+ # This field will be honored on a best effort basis.
+ #
+ # If this parameter is 0, a default value of 5 is used.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+ }</pre>
</div>
<div class="method">
@@ -544,155 +544,155 @@
An object of the form:
{ # A subscription resource.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
+ "pushConfig": { # Configuration for a push delivery endpoint. # 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.
+ "attributes": { # Endpoint configuration attributes that can be used to control different
+ # aspects of the message delivery.
+ #
+ # The only 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).
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the Pub/Sub API used to make such call. If not present in a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The only supported values for the `x-goog-version` 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.
+ #
+ # For example:
+ # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
"a_key": "A String",
},
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use `https://example.com/push`.
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A 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.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
},
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy is not set, dead lettering
- # is disabled.
- #
- # The Cloud Pub/Sub service account associated with this subscriptions's
- # parent project (i.e.,
+ },
+ "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
+ # then only `PubsubMessage`s whose `attributes` field matches the filter are
+ # delivered on this subscription. If empty, then no messages are filtered
+ # out.
+ # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+ # API might be changed in backward-incompatible ways and is not recommended
+ # for production use. It is not subject to any SLA or deprecation policy.
+ "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using
+ # non-streaming pull or send the `ack_id` 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.
+ "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
+ # from the moment a message is published.
+ # If `retain_acked_messages` is true, then this also configures the retention
+ # of acknowledged messages, and thus configures how far back in time a `Seek`
+ # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
+ # minutes.
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
# service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Acknowledge() messages on this subscription.
- # dead lettered multiple times.
+ # permission to Publish() to this topic.
#
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
- "pushConfig": { # Configuration for a push delivery endpoint. # 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.
- "attributes": { # Endpoint configuration attributes that can be used to control different
- # aspects of the message delivery.
- #
- # The only 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).
- #
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the Pub/Sub API used to make such call. If not present in a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
- #
- # The only supported values for the `x-goog-version` 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.
- #
- # For example:
- # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
- "a_key": "A String",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use `https://example.com/push`.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A 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.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
- # then only `PubsubMessage`s whose `attributes` field matches the filter are
- # delivered on this subscription. If empty, then no messages are filtered
- # out.
- # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
- # API might be changed in backward-incompatible ways and is not recommended
- # for production use. It is not subject to any SLA or deprecation policy.
- "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. During that time period, the
- # message will not be redelivered (on a best-effort basis).
+ # 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": 42, # The maximum number of delivery attempts for any message. The value must be
+ # between 5 and 100.
#
- # For pull subscriptions, this value is used as the initial value for the ack
- # deadline. To override this value for a given message, call
- # `ModifyAckDeadline` with the corresponding `ack_id` if using
- # non-streaming pull or send the `ack_id` 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.
+ # 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).
#
- # For push delivery, this value is also used to set the request timeout for
- # the call to the push endpoint.
+ # A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
+ # client libraries may automatically extend ack_deadlines.
#
- # If the subscriber never acknowledges the message, the Pub/Sub
- # system will eventually redeliver the message.
- "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
- # from the moment a message is published.
- # If `retain_acked_messages` is true, then this also configures the retention
- # of acknowledged messages, and thus configures how far back in time a `Seek`
- # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
- # minutes.
- }</pre>
+ # This field will be honored on a best effort basis.
+ #
+ # If this parameter is 0, a default value of 5 is used.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+ }</pre>
</div>
<div class="method">
@@ -791,42 +791,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -932,6 +896,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>
@@ -955,161 +955,161 @@
An object of the form:
{ # Response for the `ListSubscriptions` method.
+ "subscriptions": [ # The subscriptions that match the request.
+ { # A subscription resource.
+ "pushConfig": { # Configuration for a push delivery endpoint. # 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.
+ "attributes": { # Endpoint configuration attributes that can be used to control different
+ # aspects of the message delivery.
+ #
+ # The only 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).
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the Pub/Sub API used to make such call. If not present in a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The only supported values for the `x-goog-version` 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.
+ #
+ # For example:
+ # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
+ "a_key": "A String",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use `https://example.com/push`.
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A 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.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
+ },
+ "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
+ # then only `PubsubMessage`s whose `attributes` field matches the filter are
+ # delivered on this subscription. If empty, then no messages are filtered
+ # out.
+ # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+ # API might be changed in backward-incompatible ways and is not recommended
+ # for production use. It is not subject to any SLA or deprecation policy.
+ "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using
+ # non-streaming pull or send the `ack_id` 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.
+ "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
+ # from the moment a message is published.
+ # If `retain_acked_messages` is true, then this also configures the retention
+ # of acknowledged messages, and thus configures how far back in time a `Seek`
+ # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
+ # minutes.
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
+ # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+ # permission to Publish() to this topic.
+ #
+ # 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": 42, # 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 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.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+ },
+ ],
"nextPageToken": "A String", # If not empty, indicates that there may be more subscriptions that match
# the request; this value should be passed in a new
# `ListSubscriptionsRequest` to get more subscriptions.
- "subscriptions": [ # The subscriptions that match the request.
- { # A subscription resource.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
- "a_key": "A String",
- },
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
- },
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
- # dead lettered multiple times.
- #
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
- "pushConfig": { # Configuration for a push delivery endpoint. # 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.
- "attributes": { # Endpoint configuration attributes that can be used to control different
- # aspects of the message delivery.
- #
- # The only 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).
- #
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the Pub/Sub API used to make such call. If not present in a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
- #
- # The only supported values for the `x-goog-version` 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.
- #
- # For example:
- # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
- "a_key": "A String",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use `https://example.com/push`.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A 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.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
- # then only `PubsubMessage`s whose `attributes` field matches the filter are
- # delivered on this subscription. If empty, then no messages are filtered
- # out.
- # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
- # API might be changed in backward-incompatible ways and is not recommended
- # for production use. It is not subject to any SLA or deprecation policy.
- "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
- # `ModifyAckDeadline` with the corresponding `ack_id` if using
- # non-streaming pull or send the `ack_id` 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.
- "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
- # from the moment a message is published.
- # If `retain_acked_messages` is true, then this also configures the retention
- # of acknowledged messages, and thus configures how far back in time a `Seek`
- # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
- # minutes.
- },
- ],
}</pre>
</div>
@@ -1142,9 +1142,6 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
- "ackIds": [ # Required. List of acknowledgment IDs.
- "A String",
- ],
"ackDeadlineSeconds": 42, # Required. The new ack deadline with respect to the time this request was sent to
# the Pub/Sub system. For example, if the value is 10, the new
# ack deadline will expire 10 seconds after the `ModifyAckDeadline` call
@@ -1153,6 +1150,9 @@
# increase in the rate of message redeliveries (that is, duplicates).
# The minimum deadline you can specify is 0 seconds.
# The maximum deadline you can specify is 600 seconds (10 minutes).
+ "ackIds": [ # Required. List of acknowledgment IDs.
+ "A String",
+ ],
}
x__xgafv: string, V1 error format.
@@ -1280,236 +1280,6 @@
"updateMask": "A String", # Required. Indicates which fields in the provided subscription to update.
# Must be specified and non-empty.
"subscription": { # A subscription resource. # Required. The updated subscription object.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
- "a_key": "A String",
- },
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
- },
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
- # dead lettered multiple times.
- #
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
- "pushConfig": { # Configuration for a push delivery endpoint. # 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.
- "attributes": { # Endpoint configuration attributes that can be used to control different
- # aspects of the message delivery.
- #
- # The only 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).
- #
- # If not present during the `CreateSubscription` call, it will default to
- # the version of the Pub/Sub API used to make such call. If not present in a
- # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
- # calls will always return a valid version, even if the subscription was
- # created without this attribute.
- #
- # The only supported values for the `x-goog-version` 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.
- #
- # For example:
- # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
- "a_key": "A String",
- },
- "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
- # For example, a Webhook endpoint might use `https://example.com/push`.
- "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
- # `Authorization` header in the HTTP request for every pushed message.
- # [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect).
- "audience": "A 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.
- "serviceAccountEmail": "A String", # [Service account
- # email](https://cloud.google.com/iam/docs/service-accounts)
- # to be used for generating the OIDC token. The caller (for
- # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
- # have the iam.serviceAccounts.actAs permission for the service account.
- },
- },
- "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
- # then only `PubsubMessage`s whose `attributes` field matches the filter are
- # delivered on this subscription. If empty, then no messages are filtered
- # out.
- # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
- # API might be changed in backward-incompatible ways and is not recommended
- # for production use. It is not subject to any SLA or deprecation policy.
- "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
- # `ModifyAckDeadline` with the corresponding `ack_id` if using
- # non-streaming pull or send the `ack_id` 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.
- "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
- # from the moment a message is published.
- # If `retain_acked_messages` is true, then this also configures the retention
- # of acknowledged messages, and thus configures how far back in time a `Seek`
- # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
- # minutes.
- },
- }
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A subscription resource.
- "retainAckedMessages": True or False, # 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 `message_retention_duration`
- # window. This must be true if you would like to
- # <a
- # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
- # Seek to a timestamp</a>.
- "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
- # managing labels</a>.
- "a_key": "A String",
- },
- "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
- # *default policy* with `ttl` of 31 days will be used. The minimum allowed
- # value for `expiration_policy.ttl` is 1 day.
- # automatic resource deletion).
- "ttl": "A String", # 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.
- },
- "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
- # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
- # dead lettered multiple times.
- #
- # If validation on any of the fields fails at subscription creation/updation,
- # the create/update subscription request will fail.
- "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
- # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
- # account associated with the enclosing subscription's parent project (i.e.,
- # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
- # permission to Publish() to this topic.
- #
- # 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": 42, # 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 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.
- },
- "name": "A String", # Required. The name of the subscription. It must have the format
- # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
- # start with a letter, and contain only letters (`[A-Za-z]`), numbers
- # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
- # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
- # in length, and it must not start with `"goog"`.
- "topic": "A 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.
"pushConfig": { # Configuration for a push delivery endpoint. # 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.
@@ -1588,7 +1358,237 @@
# of acknowledged messages, and thus configures how far back in time a `Seek`
# can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
# minutes.
- }</pre>
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
+ # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+ # permission to Publish() to this topic.
+ #
+ # 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": 42, # 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 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.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+ },
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A subscription resource.
+ "pushConfig": { # Configuration for a push delivery endpoint. # 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.
+ "attributes": { # Endpoint configuration attributes that can be used to control different
+ # aspects of the message delivery.
+ #
+ # The only 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).
+ #
+ # If not present during the `CreateSubscription` call, it will default to
+ # the version of the Pub/Sub API used to make such call. If not present in a
+ # `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
+ # calls will always return a valid version, even if the subscription was
+ # created without this attribute.
+ #
+ # The only supported values for the `x-goog-version` 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.
+ #
+ # For example:
+ # <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
+ "a_key": "A String",
+ },
+ "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.
+ # For example, a Webhook endpoint might use `https://example.com/push`.
+ "oidcToken": { # Contains information needed for generating an # If specified, Pub/Sub will generate and attach an OIDC JWT token as an
+ # `Authorization` header in the HTTP request for every pushed message.
+ # [OpenID Connect
+ # token](https://developers.google.com/identity/protocols/OpenIDConnect).
+ "audience": "A 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.
+ "serviceAccountEmail": "A String", # [Service account
+ # email](https://cloud.google.com/iam/docs/service-accounts)
+ # to be used for generating the OIDC token. The caller (for
+ # CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
+ # have the iam.serviceAccounts.actAs permission for the service account.
+ },
+ },
+ "filter": "A String", # An expression written in the Cloud Pub/Sub filter language. If non-empty,
+ # then only `PubsubMessage`s whose `attributes` field matches the filter are
+ # delivered on this subscription. If empty, then no messages are filtered
+ # out.
+ # <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
+ # API might be changed in backward-incompatible ways and is not recommended
+ # for production use. It is not subject to any SLA or deprecation policy.
+ "ackDeadlineSeconds": 42, # 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 <i>outstanding</i>. 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
+ # `ModifyAckDeadline` with the corresponding `ack_id` if using
+ # non-streaming pull or send the `ack_id` 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.
+ "messageRetentionDuration": "A String", # How long to retain unacknowledged messages in the subscription's backlog,
+ # from the moment a message is published.
+ # If `retain_acked_messages` is true, then this also configures the retention
+ # of acknowledged messages, and thus configures how far back in time a `Seek`
+ # can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
+ # minutes.
+ "retainAckedMessages": True or False, # 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 `message_retention_duration`
+ # window. This must be true if you would like to
+ # <a
+ # href="https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time">
+ # Seek to a timestamp</a>.
+ "labels": { # See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and
+ # managing labels</a>.
+ "a_key": "A String",
+ },
+ "deadLetterPolicy": { # Dead lettering is done on a best effort basis. The same message might be # A policy that specifies the conditions for dead lettering messages in
+ # this subscription. If dead_letter_policy 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 Acknowledge() messages on this subscription.
+ # dead lettered multiple times.
+ #
+ # If validation on any of the fields fails at subscription creation/updation,
+ # the create/update subscription request will fail.
+ "deadLetterTopic": "A String", # The name of the topic to which dead letter messages should be published.
+ # Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
+ # account associated with the enclosing subscription's parent project (i.e.,
+ # service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
+ # permission to Publish() to this topic.
+ #
+ # 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": 42, # 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 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.
+ },
+ "expirationPolicy": { # A policy that specifies the conditions for resource expiration (i.e., # 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 `expiration_policy` is not set, a
+ # *default policy* with `ttl` of 31 days will be used. The minimum allowed
+ # value for `expiration_policy.ttl` is 1 day.
+ # automatic resource deletion).
+ "ttl": "A String", # 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.
+ },
+ "name": "A String", # Required. The name of the subscription. It must have the format
+ # `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
+ # start with a letter, and contain only letters (`[A-Za-z]`), numbers
+ # (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
+ # plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
+ # in length, and it must not start with `"goog"`.
+ "topic": "A 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.
+ }</pre>
</div>
<div class="method">
@@ -1654,6 +1654,11 @@
# library documentation</a> for more information. See
# <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a>
# for more information about message limits.
+ "publishTime": "A String", # The time at which the message was published, populated by the server when
+ # it receives the `Publish` call. It must not be populated by the
+ # publisher in a `Publish` call.
+ "data": "A String", # The message data field. If this field is empty, the message must contain
+ # at least one attribute.
"messageId": "A String", # ID of this message, assigned by the server when the message is published.
# Guaranteed to be unique within the topic. This value may be read by a
# subscriber that receives a `PubsubMessage` via a `Pull` call or a push
@@ -1662,11 +1667,6 @@
# contain non-empty data.
"a_key": "A String",
},
- "publishTime": "A String", # The time at which the message was published, populated by the server when
- # it receives the `Publish` call. It must not be populated by the
- # publisher in a `Publish` call.
- "data": "A String", # The message data field. If this field is empty, the message must contain
- # at least one attribute.
},
"ackId": "A String", # This ID can be used to acknowledge the received message.
},
@@ -1691,6 +1691,9 @@
The object takes the form of:
{ # Request for the `Seek` method.
+ "snapshot": "A String", # The snapshot to seek to. The snapshot's topic must be the same as that of
+ # the provided subscription.
+ # Format is `projects/{project}/snapshots/{snap}`.
"time": "A String", # The time to seek to.
# Messages retained in the subscription that were published before this
# time are marked as acknowledged, and messages retained in the
@@ -1702,9 +1705,6 @@
# window (or to a point before the system's notion of the subscription
# creation time), only retained messages will be marked as unacknowledged,
# and already-expunged messages will not be restored.
- "snapshot": "A String", # The snapshot to seek to. The snapshot's topic must be the same as that of
- # the provided subscription.
- # Format is `projects/{project}/snapshots/{snap}`.
}
x__xgafv: string, V1 error format.
@@ -1803,42 +1803,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -1944,6 +1908,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
},
}
@@ -2022,42 +2022,6 @@
#
# For a description of IAM and its features, see the
# [IAM documentation](https://cloud.google.com/iam/docs/).
- "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
- # prevent simultaneous updates of a policy from overwriting each other.
- # It is strongly suggested that systems make use of the `etag` in the
- # read-modify-write cycle to perform policy updates in order to avoid race
- # conditions: An `etag` is returned in the response to `getIamPolicy`, and
- # systems are expected to put that etag in the request to `setIamPolicy` to
- # ensure that their change will be applied to the same version of the policy.
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- "version": 42, # Specifies the format of the policy.
- #
- # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
- # are rejected.
- #
- # Any operation that affects conditional role bindings must specify version
- # `3`. This requirement applies to the following operations:
- #
- # * Getting a policy that includes a conditional role binding
- # * Adding a conditional role binding to a policy
- # * Changing a conditional role binding in a policy
- # * Removing any role binding, with or without a condition, from a policy
- # that includes conditions
- #
- # **Important:** If you use IAM Conditions, you must include the `etag` field
- # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
- # you to overwrite a version `3` policy with a version `1` policy, and all of
- # the conditions in the version `3` policy are lost.
- #
- # If a policy does not include any conditions, operations on that policy may
- # specify any valid version or leave the field unset.
- #
- # To learn which resources support conditions in their IAM policies, see the
- # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
# `condition` that determines how and when the `bindings` are applied. Each
# of the `bindings` must contain at least one member.
@@ -2163,6 +2127,42 @@
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
},
],
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
}</pre>
</div>