Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f3348f98bf91a88a28bf61b12b95e391cc3be1ff / . / docs / dyn / pubsub_v1beta1a.topics.html
blob: dc8ac17e3831426fc9a89e87de4ede8d925efffb [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="pubsub_v1beta1a.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.topics.html">topics</a></h1>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]79<p class="firstline">Creates the given topic with the given name.</p>
80<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]81 <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Deletes the topic with the given name. Returns NOT_FOUND if the topic does</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]84 <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Gets the configuration of a topic. Since the topic only has the name</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]87 <code><a href="#list">list(maxResults=None, query=None, pageToken=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]88<p class="firstline">Lists matching topics.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]94<p class="firstline">Adds a message to the topic. Returns NOT_FOUND if the topic does not</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#publishBatch">publishBatch(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]97<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101 <pre>Creates the given topic with the given name.
102
103Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]105 The object takes the form of:
106
107{ # A topic resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]109}
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]110
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]111 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]115
116Returns:
117 An object of the form:
118
119 { # A topic resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]120 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]121 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]122</div>
123
124<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]125 <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]126 <pre>Deletes the topic with the given name. Returns NOT_FOUND if the topic does
127not exist. After a topic is deleted, a new topic may be created with the
128same name.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]129
130Args:
131 topic: string, Name of the topic to delete. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]132 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]133 Allowed values
134 1 - v1 error format
135 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]136
137Returns:
138 An object of the form:
139
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]140 { # An empty message that you can re-use to avoid defining duplicated empty
141 # messages in your project. A typical example is to use it as argument or the
142 # return value of a service API. For instance:
143 #
144 # service Foo {
145 # rpc Bar (proto2.Empty) returns (proto2.Empty) { };
146 # };
147 #
148 # BEGIN GOOGLE-INTERNAL
149 # The difference between this one and net/rpc/empty-message.proto is that
150 # 1) The generated message here is in proto2 C++ API.
151 # 2) The proto2.Empty has minimum dependencies
152 # (no message_set or net/rpc dependencies)
153 # END GOOGLE-INTERNAL
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]154 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]155</div>
156
157<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]158 <code class="details" id="get">get(topic, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]159 <pre>Gets the configuration of a topic. Since the topic only has the name
160attribute, this method is only useful to check the existence of a topic.
161If other attributes are added in the future, they will be returned here.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]162
163Args:
164 topic: string, The name of the topic to get. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]165 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]169
170Returns:
171 An object of the form:
172
173 { # A topic resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]174 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]175 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]176</div>
177
178<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]179 <code class="details" id="list">list(maxResults=None, query=None, pageToken=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]180 <pre>Lists matching topics.
181
182Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]183 maxResults: integer, Maximum number of topics to return.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]184 query: string, A valid label query expression.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]185 pageToken: string, The value obtained in the last &lt;code&gt;ListTopicsResponse&lt;/code&gt;
186for continuation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]187 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191
192Returns:
193 An object of the form:
194
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]195 { # Response for the ListTopics method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]196 &quot;topic&quot;: [ # The resulting topics.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]197 { # A topic resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]198 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]199 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]201 &quot;nextPageToken&quot;: &quot;A String&quot;, # If not empty, indicates that there are more topics that match the request,
202 # and this value should be passed to the next &lt;code&gt;ListTopicsRequest&lt;/code&gt;
203 # to continue.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]204 }</pre>
205</div>
206
207<div class="method">
208 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
209 <pre>Retrieves the next page of results.
210
211Args:
212 previous_request: The request for the previous page. (required)
213 previous_response: The response from the request for the previous page. (required)
214
215Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]217 page. Returns None if there are no more items in the collection.
218 </pre>
219</div>
220
221<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]222 <code class="details" id="publish">publish(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]223 <pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not
224exist.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]225
226Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]228 The object takes the form of:
229
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]230{ # Request for the Publish method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]231 &quot;topic&quot;: &quot;A String&quot;, # The message in the request will be published on this topic.
232 &quot;message&quot;: { # A message data and its labels. # The message to publish.
233 &quot;messageId&quot;: &quot;A String&quot;, # ID of this message assigned by the server at publication time. Guaranteed
234 # to be unique within the topic. This value may be read by a subscriber
235 # that receives a PubsubMessage via a Pull call or a push delivery. It must
236 # not be populated by a publisher in a Publish call.
237 &quot;publishTime&quot;: &quot;A String&quot;, # The time at which the message was published.
238 # The time is milliseconds since the UNIX epoch.
239 &quot;label&quot;: [ # Optional list of labels for this message. Keys in this collection must
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]240 # be unique.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]241 { # A key-value pair applied to a given object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]242 &quot;key&quot;: &quot;A String&quot;, # The key of a label is a syntactically valid URL (as per RFC 1738) with
243 # the &quot;scheme&quot; and initial slashes omitted and with the additional
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]244 # restrictions noted below. Each key should be globally unique. The
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]245 # &quot;host&quot; portion is called the &quot;namespace&quot; and is not necessarily
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]246 # resolvable to a network endpoint. Instead, the namespace indicates what
247 # system or entity defines the semantics of the label. Namespaces do not
248 # restrict the set of objects to which a label may be associated.
249 #
250 # Keys are defined by the following grammar:
251 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]252 # key = hostname &quot;/&quot; kpath
253 # kpath = ksegment *[ &quot;/&quot; ksegment ]
254 # ksegment = alphadigit | *[ alphadigit | &quot;-&quot; | &quot;_&quot; | &quot;.&quot; ]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]255 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]256 # where &quot;hostname&quot; and &quot;alphadigit&quot; are defined as in RFC 1738.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]257 #
258 # Example key:
259 # spanner.google.com/universe
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]260 &quot;strValue&quot;: &quot;A String&quot;, # A string value.
261 &quot;numValue&quot;: &quot;A String&quot;, # An integer value.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]262 },
263 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 &quot;data&quot;: &quot;A String&quot;, # The message payload.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]265 },
266 }
267
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]268 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]269 Allowed values
270 1 - v1 error format
271 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]272
273Returns:
274 An object of the form:
275
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]276 { # An empty message that you can re-use to avoid defining duplicated empty
277 # messages in your project. A typical example is to use it as argument or the
278 # return value of a service API. For instance:
279 #
280 # service Foo {
281 # rpc Bar (proto2.Empty) returns (proto2.Empty) { };
282 # };
283 #
284 # BEGIN GOOGLE-INTERNAL
285 # The difference between this one and net/rpc/empty-message.proto is that
286 # 1) The generated message here is in proto2 C++ API.
287 # 2) The proto2.Empty has minimum dependencies
288 # (no message_set or net/rpc dependencies)
289 # END GOOGLE-INTERNAL
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]290 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]291</div>
292
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]293<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]294 <code class="details" id="publishBatch">publishBatch(body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]295 <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does
296not exist.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]297
298Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]299 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]300 The object takes the form of:
301
302{ # Request for the PublishBatch method.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]303 &quot;topic&quot;: &quot;A String&quot;, # The messages in the request will be published on this topic.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]304 &quot;messages&quot;: [ # The messages to publish.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]305 { # A message data and its labels.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]306 &quot;messageId&quot;: &quot;A String&quot;, # ID of this message assigned by the server at publication time. Guaranteed
307 # to be unique within the topic. This value may be read by a subscriber
308 # that receives a PubsubMessage via a Pull call or a push delivery. It must
309 # not be populated by a publisher in a Publish call.
310 &quot;publishTime&quot;: &quot;A String&quot;, # The time at which the message was published.
311 # The time is milliseconds since the UNIX epoch.
312 &quot;label&quot;: [ # Optional list of labels for this message. Keys in this collection must
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]313 # be unique.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]314 { # A key-value pair applied to a given object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]315 &quot;key&quot;: &quot;A String&quot;, # The key of a label is a syntactically valid URL (as per RFC 1738) with
316 # the &quot;scheme&quot; and initial slashes omitted and with the additional
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]317 # restrictions noted below. Each key should be globally unique. The
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]318 # &quot;host&quot; portion is called the &quot;namespace&quot; and is not necessarily
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]319 # resolvable to a network endpoint. Instead, the namespace indicates what
320 # system or entity defines the semantics of the label. Namespaces do not
321 # restrict the set of objects to which a label may be associated.
322 #
323 # Keys are defined by the following grammar:
324 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]325 # key = hostname &quot;/&quot; kpath
326 # kpath = ksegment *[ &quot;/&quot; ksegment ]
327 # ksegment = alphadigit | *[ alphadigit | &quot;-&quot; | &quot;_&quot; | &quot;.&quot; ]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]328 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]329 # where &quot;hostname&quot; and &quot;alphadigit&quot; are defined as in RFC 1738.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]330 #
331 # Example key:
332 # spanner.google.com/universe
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]333 &quot;strValue&quot;: &quot;A String&quot;, # A string value.
334 &quot;numValue&quot;: &quot;A String&quot;, # An integer value.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]335 },
336 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]337 &quot;data&quot;: &quot;A String&quot;, # The message payload.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]338 },
339 ],
340 }
341
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]342 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]346
347Returns:
348 An object of the form:
349
350 { # Response for the PublishBatch method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]351 &quot;messageIds&quot;: [ # The server-assigned ID of each published message, in the same order as
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]352 # the messages in the request. IDs are guaranteed to be unique within
353 # the topic.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]354 &quot;A String&quot;,
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]355 ],
356 }</pre>
357</div>
358
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]359</body></html>