chore: regens API reference docs (#889)
diff --git a/docs/dyn/pubsub_v1beta1a.subscriptions.html b/docs/dyn/pubsub_v1beta1a.subscriptions.html
index d804168..2398144 100644
--- a/docs/dyn/pubsub_v1beta1a.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta1a.subscriptions.html
@@ -75,10 +75,10 @@
<h1><a href="pubsub_v1beta1a.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.subscriptions.html">subscriptions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#acknowledge">acknowledge(body, x__xgafv=None)</a></code></p>
+ <code><a href="#acknowledge">acknowledge(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Acknowledges a particular received message: the Pub/Sub system can remove</p>
<p class="toc_element">
- <code><a href="#create">create(body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a subscription on a given topic for a given subscriber.</p>
<p class="toc_element">
<code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>
@@ -93,20 +93,20 @@
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#modifyAckDeadline">modifyAckDeadline(body, x__xgafv=None)</a></code></p>
+ <code><a href="#modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the Ack deadline for a message received from a pull request.</p>
<p class="toc_element">
- <code><a href="#modifyPushConfig">modifyPushConfig(body, x__xgafv=None)</a></code></p>
+ <code><a href="#modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Modifies the <code>PushConfig</code> for a specified subscription.</p>
<p class="toc_element">
- <code><a href="#pull">pull(body, x__xgafv=None)</a></code></p>
+ <code><a href="#pull">pull(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Pulls a single message from the server.</p>
<p class="toc_element">
- <code><a href="#pullBatch">pullBatch(body, x__xgafv=None)</a></code></p>
+ <code><a href="#pullBatch">pullBatch(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Pulls messages from the server. Returns an empty list if there are no</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="acknowledge">acknowledge(body, x__xgafv=None)</code>
+ <code class="details" id="acknowledge">acknowledge(body=None, x__xgafv=None)</code>
<pre>Acknowledges a particular received message: the Pub/Sub system can remove
the given message from the subscription. Acknowledging a message whose
Ack deadline has expired may succeed, but the message could have been
@@ -114,7 +114,7 @@
result in an error. This is only used for messages received via pull.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the Acknowledge method.
@@ -151,7 +151,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(body, x__xgafv=None)</code>
+ <code class="details" id="create">create(body=None, x__xgafv=None)</code>
<pre>Creates a subscription on a given topic for a given subscriber.
If the subscription already exists, returns ALREADY_EXISTS.
If the corresponding topic doesn't exist, returns NOT_FOUND.
@@ -160,37 +160,37 @@
name for this subscription on the same project as the topic.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "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".
- },
- "name": "A String", # Name of the subscription.
- }
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "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".
+ },
+ "name": "A String", # Name of the subscription.
+}
x__xgafv: string, V1 error format.
Allowed values
@@ -201,33 +201,33 @@
An object of the form:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "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".
- },
- "name": "A String", # Name of the subscription.
- }</pre>
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "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".
+ },
+ "name": "A String", # Name of the subscription.
+ }</pre>
</div>
<div class="method">
@@ -278,33 +278,33 @@
An object of the form:
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "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".
- },
- "name": "A String", # Name of the subscription.
- }</pre>
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "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".
+ },
+ "name": "A String", # Name of the subscription.
+ }</pre>
</div>
<div class="method">
@@ -313,7 +313,7 @@
Args:
maxResults: integer, Maximum number of subscriptions to return.
- pageToken: string, The value obtained in the last <code>ListSubscriptionsResponse</code>
+ pageToken: string, The value obtained in the last <code>ListSubscriptionsResponse</code>
for continuation.
query: string, A valid label query expression.
x__xgafv: string, V1 error format.
@@ -327,36 +327,36 @@
{ # Response for the ListSubscriptions method.
"nextPageToken": "A String", # If not empty, indicates that there are more subscriptions that match the
# request and this value should be passed to the next
- # <code>ListSubscriptionsRequest</code> to continue.
+ # <code>ListSubscriptionsRequest</code> to continue.
"subscription": [ # The subscriptions that match the request.
{ # A subscription resource.
- "topic": "A String", # The name of the topic from which this subscription is receiving messages.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
- # subscriber receives a message before the subscriber should acknowledge or
- # Nack the message. If the Ack deadline for a message passes without an
- # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
- # If a subscriber acknowledges after the deadline, the Pub/Sub system may
- # accept the Ack, but it is possible that the message has been already
- # delivered again. Multiple Acks to the message are allowed and will
- # succeed.
- #
- # For push delivery, this value is used to set the request timeout for
- # the call to the push endpoint.
- #
- # For pull delivery, this value is used as the initial value for the Ack
- # deadline. It may be overridden for each message using its corresponding
- # ack_id with <code>ModifyAckDeadline</code>.
- # While a message is outstanding (i.e. it has been delivered to a pull
- # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
- # system will not deliver that message to another pull subscriber
- # (on a best-effort basis).
- "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
- # used to configure it.
- "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".
- },
- "name": "A String", # Name of the subscription.
+ "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ # subscriber receives a message before the subscriber should acknowledge or
+ # Nack the message. If the Ack deadline for a message passes without an
+ # Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
+ # If a subscriber acknowledges after the deadline, the Pub/Sub system may
+ # accept the Ack, but it is possible that the message has been already
+ # delivered again. Multiple Acks to the message are allowed and will
+ # succeed.
+ #
+ # For push delivery, this value is used to set the request timeout for
+ # the call to the push endpoint.
+ #
+ # For pull delivery, this value is used as the initial value for the Ack
+ # deadline. It may be overridden for each message using its corresponding
+ # ack_id with <code>ModifyAckDeadline</code>.
+ # While a message is outstanding (i.e. it has been delivered to a pull
+ # subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub
+ # system will not deliver that message to another pull subscriber
+ # (on a best-effort basis).
+ "topic": "A String", # The name of the topic from which this subscription is receiving messages.
+ "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is
+ # used to configure it.
+ "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".
},
+ "name": "A String", # Name of the subscription.
+ },
],
}</pre>
</div>
@@ -376,25 +376,25 @@
</div>
<div class="method">
- <code class="details" id="modifyAckDeadline">modifyAckDeadline(body, x__xgafv=None)</code>
+ <code class="details" id="modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</code>
<pre>Modifies the Ack deadline for a message received from a pull request.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
"ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the
- # Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack
+ # Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack
# deadline will expire 10 seconds after the ModifyAckDeadline call was made.
# Specifying zero may immediately make the message available for another pull
# request.
- "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated,
- # not both.
"ackIds": [ # List of acknowledgment IDs. Either this field or ack_id
# should be populated, not both.
"A String",
],
+ "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated,
+ # not both.
"subscription": "A String", # Next Index: 5
# The name of the subscription from which messages are being pulled.
}
@@ -425,19 +425,19 @@
</div>
<div class="method">
- <code class="details" id="modifyPushConfig">modifyPushConfig(body, x__xgafv=None)</code>
- <pre>Modifies the <code>PushConfig</code> for a specified subscription.
+ <code class="details" id="modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</code>
+ <pre>Modifies the <code>PushConfig</code> for a specified subscription.
This method can be used to suspend the flow of messages to an endpoint
-by clearing the <code>PushConfig</code> field in the request. Messages
+by clearing the <code>PushConfig</code> field in the request. Messages
will be accumulated for delivery even if no push configuration is
defined or while the configuration is modified.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the ModifyPushConfig method.
- "pushConfig": { # Configuration for a push delivery endpoint. # An empty <code>push_config</code> indicates that the Pub/Sub system should
+ "pushConfig": { # Configuration for a push delivery endpoint. # An empty <code>push_config</code> indicates that the Pub/Sub system should
# pause pushing messages from the given subscription.
"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".
@@ -471,7 +471,7 @@
</div>
<div class="method">
- <code class="details" id="pull">pull(body, x__xgafv=None)</code>
+ <code class="details" id="pull">pull(body=None, x__xgafv=None)</code>
<pre>Pulls a single message from the server.
If return_immediately is true, and no messages are available in the
subscription, this method returns FAILED_PRECONDITION. The system is free
@@ -479,7 +479,7 @@
reasonable amount of time (to reduce system load).
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the Pull method.
@@ -499,7 +499,7 @@
Returns:
An object of the form:
- { # Either a <code>PubsubMessage</code> or a truncation event. One of these two
+ { # Either a <code>PubsubMessage</code> or a truncation event. One of these two
# must be populated.
"pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.
"deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull
@@ -539,21 +539,21 @@
# that receives a PubsubMessage via a Pull call or a push delivery. It must
# not be populated by a publisher in a Publish call.
},
- "truncated": True or False, # Indicates that this subscription has been truncated.
"subscription": "A String", # The subscription that received the event.
+ "truncated": True or False, # Indicates that this subscription has been truncated.
},
"ackId": "A String", # This ID must be used to acknowledge the received event or message.
}</pre>
</div>
<div class="method">
- <code class="details" id="pullBatch">pullBatch(body, x__xgafv=None)</code>
+ <code class="details" id="pullBatch">pullBatch(body=None, x__xgafv=None)</code>
<pre>Pulls messages from the server. Returns an empty list if there are no
messages available in the backlog. The system is free to return UNAVAILABLE
if there are too many pull requests outstanding for the given subscription.
Args:
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Request for the PullBatch method.
@@ -580,7 +580,7 @@
# zero messages if there are no more messages available in the backlog. The
# Pub/Sub system may return fewer than the max_events requested even if
# there are more messages available in the backlog.
- { # Either a <code>PubsubMessage</code> or a truncation event. One of these two
+ { # Either a <code>PubsubMessage</code> or a truncation event. One of these two
# must be populated.
"pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.
"deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull
@@ -620,8 +620,8 @@
# that receives a PubsubMessage via a Pull call or a push delivery. It must
# not be populated by a publisher in a Publish call.
},
- "truncated": True or False, # Indicates that this subscription has been truncated.
"subscription": "A String", # The subscription that received the event.
+ "truncated": True or False, # Indicates that this subscription has been truncated.
},
"ackId": "A String", # This ID must be used to acknowledge the received event or message.
},