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.topics.html b/docs/dyn/pubsub_v1beta1a.topics.html
index 8c8586b..2f6815c 100644
--- a/docs/dyn/pubsub_v1beta1a.topics.html
+++ b/docs/dyn/pubsub_v1beta1a.topics.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the configuration of a topic. Since the topic only has the name</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 topics.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -105,7 +105,7 @@
The object takes the form of:
{ # A topic resource.
- "name": "A String", # Name of the topic.
+ "name": "A String", # Name of the topic.
}
x__xgafv: string, V1 error format.
@@ -117,7 +117,7 @@
An object of the form:
{ # A topic resource.
- "name": "A String", # Name of the topic.
+ "name": "A String", # Name of the topic.
}</pre>
</div>
@@ -171,18 +171,18 @@
An object of the form:
{ # A topic resource.
- "name": "A String", # Name of the topic.
+ "name": "A String", # Name of the topic.
}</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 topics.
Args:
- maxResults: integer, Maximum number of topics to return.
pageToken: string, The value obtained in the last <code>ListTopicsResponse</code>
for continuation.
+ maxResults: integer, Maximum number of topics to return.
query: string, A valid label query expression.
x__xgafv: string, V1 error format.
Allowed values
@@ -193,12 +193,12 @@
An object of the form:
{ # Response for the ListTopics method.
- "nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request,
+ "nextPageToken": "A String", # If not empty, indicates that there are more topics that match the request,
# and this value should be passed to the next <code>ListTopicsRequest</code>
# to continue.
- "topic": [ # The resulting topics.
+ "topic": [ # The resulting topics.
{ # A topic resource.
- "name": "A String", # Name of the topic.
+ "name": "A String", # Name of the topic.
},
],
}</pre>
@@ -213,7 +213,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>
@@ -228,40 +228,40 @@
The object takes the form of:
{ # Request for the Publish method.
- "topic": "A String", # The message in the request will be published on this topic.
- "message": { # A message data and its labels. # The message to publish.
- "label": [ # Optional list of labels for this message. Keys in this collection must
+ "topic": "A String", # The message in the request will be published on this topic.
+ "message": { # A message data and its labels. # The message to publish.
+ "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.
},
}
@@ -300,43 +300,43 @@
The object takes the form of:
{ # Request for the PublishBatch method.
- "topic": "A String", # The messages in the request will be published on this topic.
- "messages": [ # The messages to publish.
+ "messages": [ # The messages to publish.
{ # A message data and its labels.
- "label": [ # Optional list of labels for this message. Keys in this collection must
+ "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.
},
],
+ "topic": "A String", # The messages in the request will be published on this topic.
}
x__xgafv: string, V1 error format.
@@ -348,10 +348,10 @@
An object of the form:
{ # Response for the PublishBatch method.
- "messageIds": [ # The server-assigned ID of each published message, in the same order as
+ "messageIds": [ # The server-assigned ID of each published message, in the same order as
# the messages in the request. IDs are guaranteed to be unique within
# the topic.
- "A String",
+ "A String",
],
}</pre>
</div>