docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/pubsub_v1beta1a.subscriptions.html b/docs/dyn/pubsub_v1beta1a.subscriptions.html
index 3f6974c..ab950a4 100644
--- a/docs/dyn/pubsub_v1beta1a.subscriptions.html
+++ b/docs/dyn/pubsub_v1beta1a.subscriptions.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration details of a subscription.</p>
<p class="toc_element">
- <code><a href="#list">list(pageToken=None, maxResults=None, query=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(maxResults=None, query=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists matching subscriptions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -164,12 +164,6 @@
The object takes the form of:
{ # A subscription resource.
- "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".
- },
"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
@@ -190,6 +184,12 @@
# system will not deliver that message to another pull subscriber
# (on a best-effort basis).
"name": "A String", # Name of the subscription.
+ "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".
+ },
}
x__xgafv: string, V1 error format.
@@ -201,12 +201,6 @@
An object of the form:
{ # A subscription resource.
- "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".
- },
"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
@@ -227,6 +221,12 @@
# system will not deliver that message to another pull subscriber
# (on a best-effort basis).
"name": "A String", # Name of the subscription.
+ "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".
+ },
}</pre>
</div>
@@ -278,12 +278,6 @@
An object of the form:
{ # A subscription resource.
- "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".
- },
"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
@@ -304,18 +298,24 @@
# system will not deliver that message to another pull subscriber
# (on a best-effort basis).
"name": "A String", # Name of the subscription.
+ "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".
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(pageToken=None, maxResults=None, query=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(maxResults=None, query=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists matching subscriptions.
Args:
- pageToken: string, The value obtained in the last <code>ListSubscriptionsResponse</code>
-for continuation.
maxResults: integer, Maximum number of subscriptions to return.
query: string, A valid label query expression.
+ pageToken: string, The value obtained in the last <code>ListSubscriptionsResponse</code>
+for continuation.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -325,14 +325,11 @@
An object of the form:
{ # 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.
"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.
- "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".
- },
"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
@@ -353,11 +350,14 @@
# system will not deliver that message to another pull subscriber
# (on a best-effort basis).
"name": "A String", # Name of the subscription.
+ "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".
+ },
},
],
- "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.
}</pre>
</div>
@@ -384,12 +384,6 @@
The object takes the form of:
{ # Request for the ModifyAckDeadline method.
- "ackIds": [ # List of acknowledgment IDs. Either this field or ack_id
- # should be populated, not both.
- "A String",
- ],
- "subscription": "A String", # Next Index: 5
- # The name of the subscription from which messages are being pulled.
"ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated,
# not both.
"ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the
@@ -397,6 +391,12 @@
# deadline will expire 10 seconds after the ModifyAckDeadline call was made.
# Specifying zero may immediately make the message available for another pull
# request.
+ "ackIds": [ # List of acknowledgment IDs. Either this field or ack_id
+ # should be populated, not both.
+ "A String",
+ ],
+ "subscription": "A String", # Next Index: 5
+ # The name of the subscription from which messages are being pulled.
}
x__xgafv: string, V1 error format.
@@ -483,12 +483,12 @@
The object takes the form of:
{ # Request for the Pull method.
- "subscription": "A String", # The subscription from which a message should be pulled.
"returnImmediately": True or False, # If this is specified as true the system will respond immediately even if
# it is not able to return a message in the Pull response. Otherwise the
# system is allowed to wait until at least one message is available rather
# than returning FAILED_PRECONDITION. The client may cancel the request if
# it does not wish to wait any longer for the response.
+ "subscription": "A String", # The subscription from which a message should be pulled.
}
x__xgafv: string, V1 error format.
@@ -503,6 +503,10 @@
# must be populated.
"ackId": "A String", # This ID must be used to acknowledge the received event or message.
"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
+ # subscribers will always receive NOT_FOUND in response in their pull
+ # request on the subscription, rather than seeing this boolean.)
+ "truncated": True or False, # Indicates that this subscription has been truncated.
"message": { # A message data and its labels. # A received message.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed
# to be unique within the topic. This value may be read by a subscriber
@@ -513,8 +517,6 @@
"label": [ # Optional list of labels for this message. Keys in this collection must
# be unique.
{ # A key-value pair applied to a given object.
- "strValue": "A String", # A string value.
- "numValue": "A String", # An integer value.
"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with
# the "scheme" and initial slashes omitted and with the additional
# restrictions noted below. Each key should be globally unique. The
@@ -533,15 +535,13 @@
#
# Example key:
# spanner.google.com/universe
+ "strValue": "A String", # A string value.
+ "numValue": "A String", # An integer value.
},
],
"data": "A String", # The message payload.
},
"subscription": "A String", # The subscription that received the event.
- "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull
- # subscribers will always receive NOT_FOUND in response in their pull
- # request on the subscription, rather than seeing this boolean.)
- "truncated": True or False, # Indicates that this subscription has been truncated.
},
}</pre>
</div>
@@ -584,6 +584,10 @@
# must be populated.
"ackId": "A String", # This ID must be used to acknowledge the received event or message.
"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
+ # subscribers will always receive NOT_FOUND in response in their pull
+ # request on the subscription, rather than seeing this boolean.)
+ "truncated": True or False, # Indicates that this subscription has been truncated.
"message": { # A message data and its labels. # A received message.
"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed
# to be unique within the topic. This value may be read by a subscriber
@@ -594,8 +598,6 @@
"label": [ # Optional list of labels for this message. Keys in this collection must
# be unique.
{ # A key-value pair applied to a given object.
- "strValue": "A String", # A string value.
- "numValue": "A String", # An integer value.
"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with
# the "scheme" and initial slashes omitted and with the additional
# restrictions noted below. Each key should be globally unique. The
@@ -614,15 +616,13 @@
#
# Example key:
# spanner.google.com/universe
+ "strValue": "A String", # A string value.
+ "numValue": "A String", # An integer value.
},
],
"data": "A String", # The message payload.
},
"subscription": "A String", # The subscription that received the event.
- "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull
- # subscribers will always receive NOT_FOUND in response in their pull
- # request on the subscription, rather than seeing this boolean.)
- "truncated": True or False, # Indicates that this subscription has been truncated.
},
},
],