docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/pubsub_v1beta1a.subscriptions.html b/docs/dyn/pubsub_v1beta1a.subscriptions.html
index 2398144..3f6974c 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(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(pageToken=None, maxResults=None, query=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>
@@ -118,11 +118,11 @@
The object takes the form of:
{ # Request for the Acknowledge method.
- "ackId": [ # The acknowledgment ID for the message being acknowledged. This was
+ "subscription": "A String", # The subscription whose message is being acknowledged.
+ "ackId": [ # The acknowledgment ID for the message being acknowledged. This was
# returned by the Pub/Sub system in the Pull response.
- "A String",
+ "A String",
],
- "subscription": "A String", # The subscription whose message is being acknowledged.
}
x__xgafv: string, V1 error format.
@@ -154,7 +154,7 @@
<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.
+If the corresponding topic doesn't exist, returns NOT_FOUND.
If the name is not provided in the request, the server will assign a random
name for this subscription on the same project as the topic.
@@ -164,7 +164,13 @@
The object takes the form of:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ "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
# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
@@ -183,13 +189,7 @@
# 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.
+ "name": "A String", # Name of the subscription.
}
x__xgafv: string, V1 error format.
@@ -201,7 +201,13 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ "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
# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
@@ -220,13 +226,7 @@
# 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.
+ "name": "A String", # Name of the subscription.
}</pre>
</div>
@@ -278,7 +278,13 @@
An object of the form:
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ "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
# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
@@ -297,24 +303,18 @@
# 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.
+ "name": "A String", # Name of the subscription.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(pageToken=None, maxResults=None, query=None, x__xgafv=None)</code>
<pre>Lists matching subscriptions.
Args:
- maxResults: integer, Maximum number of subscriptions to return.
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.
x__xgafv: string, V1 error format.
Allowed values
@@ -325,12 +325,15 @@
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.
+ "subscription": [ # The subscriptions that match the request.
{ # A subscription resource.
- "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a
+ "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
# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.
@@ -349,15 +352,12 @@
# 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.
+ "name": "A String", # Name of the subscription.
},
],
+ "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>
@@ -370,7 +370,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -384,19 +384,19 @@
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
+ "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
# 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.
- "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.
}
x__xgafv: string, V1 error format.
@@ -437,12 +437,12 @@
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".
+ "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".
},
- "subscription": "A String", # The name of the subscription.
+ "subscription": "A String", # The name of the subscription.
}
x__xgafv: string, V1 error format.
@@ -483,12 +483,12 @@
The object takes the form of:
{ # Request for the Pull method.
- "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if
+ "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.
@@ -501,48 +501,48 @@
{ # 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
- # subscribers will always receive NOT_FOUND in response in their pull
- # request on the subscription, rather than seeing this boolean.)
- "message": { # A message data and its labels. # A received message.
- "label": [ # Optional list of labels for this message. Keys in this collection must
+ "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.
+ "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
+ # that receives a PubsubMessage via a Pull call or a push delivery. It must
+ # not be populated by a publisher in a Publish call.
+ "publishTime": "A String", # The time at which the message was published.
+ # The time is milliseconds since the UNIX epoch.
+ "label": [ # Optional list of labels for this message. Keys in this collection must
# be unique.
{ # A key-value pair applied to a given object.
- "numValue": "A String", # An integer value.
- "strValue": "A String", # A string 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
+ "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
- # "host" portion is called the "namespace" and is not necessarily
+ # "host" portion is called the "namespace" and is not necessarily
# resolvable to a network endpoint. Instead, the namespace indicates what
# system or entity defines the semantics of the label. Namespaces do not
# restrict the set of objects to which a label may be associated.
#
# Keys are defined by the following grammar:
#
- # key = hostname "/" kpath
- # kpath = ksegment *[ "/" ksegment ]
- # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
+ # key = hostname "/" kpath
+ # kpath = ksegment *[ "/" ksegment ]
+ # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
#
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
+ # where "hostname" and "alphadigit" are defined as in RFC 1738.
#
# Example key:
# spanner.google.com/universe
},
],
- "data": "A String", # The message payload.
- "publishTime": "A String", # The time at which the message was published.
- # The time is milliseconds since the UNIX epoch.
- "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
- # that receives a PubsubMessage via a Pull call or a push delivery. It must
- # not be populated by a publisher in a Publish call.
+ "data": "A String", # The message payload.
},
- "subscription": "A String", # The subscription that received the event.
- "truncated": True or False, # Indicates that this subscription has been truncated.
+ "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.
},
- "ackId": "A String", # This ID must be used to acknowledge the received event or message.
}</pre>
</div>
@@ -557,14 +557,14 @@
The object takes the form of:
{ # Request for the PullBatch method.
- "maxEvents": 42, # The maximum number of PubsubEvents returned for this request. The Pub/Sub
- # system may return fewer than the number of events specified.
- "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if
+ "subscription": "A String", # The subscription from which messages 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 no messages. 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 messages should be pulled.
+ "maxEvents": 42, # The maximum number of PubsubEvents returned for this request. The Pub/Sub
+ # system may return fewer than the number of events specified.
}
x__xgafv: string, V1 error format.
@@ -576,54 +576,54 @@
An object of the form:
{ # Response for the PullBatch method.
- "pullResponses": [ # Received Pub/Sub messages or status events. The Pub/Sub system will return
+ "pullResponses": [ # Received Pub/Sub messages or status events. The Pub/Sub system will return
# 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
# 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
- # subscribers will always receive NOT_FOUND in response in their pull
- # request on the subscription, rather than seeing this boolean.)
- "message": { # A message data and its labels. # A received message.
- "label": [ # Optional list of labels for this message. Keys in this collection must
+ "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.
+ "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
+ # that receives a PubsubMessage via a Pull call or a push delivery. It must
+ # not be populated by a publisher in a Publish call.
+ "publishTime": "A String", # The time at which the message was published.
+ # The time is milliseconds since the UNIX epoch.
+ "label": [ # Optional list of labels for this message. Keys in this collection must
# be unique.
{ # A key-value pair applied to a given object.
- "numValue": "A String", # An integer value.
- "strValue": "A String", # A string 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
+ "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
- # "host" portion is called the "namespace" and is not necessarily
+ # "host" portion is called the "namespace" and is not necessarily
# resolvable to a network endpoint. Instead, the namespace indicates what
# system or entity defines the semantics of the label. Namespaces do not
# restrict the set of objects to which a label may be associated.
#
# Keys are defined by the following grammar:
#
- # key = hostname "/" kpath
- # kpath = ksegment *[ "/" ksegment ]
- # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
+ # key = hostname "/" kpath
+ # kpath = ksegment *[ "/" ksegment ]
+ # ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]
#
- # where "hostname" and "alphadigit" are defined as in RFC 1738.
+ # where "hostname" and "alphadigit" are defined as in RFC 1738.
#
# Example key:
# spanner.google.com/universe
},
],
- "data": "A String", # The message payload.
- "publishTime": "A String", # The time at which the message was published.
- # The time is milliseconds since the UNIX epoch.
- "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
- # that receives a PubsubMessage via a Pull call or a push delivery. It must
- # not be populated by a publisher in a Publish call.
+ "data": "A String", # The message payload.
},
- "subscription": "A String", # The subscription that received the event.
- "truncated": True or False, # Indicates that this subscription has been truncated.
+ "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.
},
- "ackId": "A String", # This ID must be used to acknowledge the received event or message.
},
],
}</pre>