blob: 44109388345b939c02ac52c7489d5ddadfbcf52e [file] [log] [blame]
Craig Citro065b5302014-08-14 00:47:23 -07001<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 -070075<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 -070076<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070081 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070082<p class="firstline">Creates the given topic with the given name.</p>
83<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070084 <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<p class="firstline">Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.</p>
Craig Citro065b5302014-08-14 00:47:23 -070086<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -070087 <code><a href="#get">get(topic, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070088<p class="firstline">Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.</p>
Craig Citro065b5302014-08-14 00:47:23 -070089<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080090 <code><a href="#list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -070091<p class="firstline">Lists matching topics.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070096 <code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070097<p class="firstline">Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.</p>
Craig Citroe633be12015-03-02 13:40:36 -080098<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#publishBatch">publishBatch(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700108 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700109 <pre>Creates the given topic with the given name.
110
111Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700112 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700113 The object takes the form of:
114
115{ # A topic resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800116 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
117}
Craig Citro065b5302014-08-14 00:47:23 -0700118
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700119 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800120 Allowed values
121 1 - v1 error format
122 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700123
124Returns:
125 An object of the form:
126
127 { # A topic resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
129}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700130</div>
131
132<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700133 <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700134 <pre>Deletes the topic with the given name. Returns NOT_FOUND if the topic does not exist. After a topic is deleted, a new topic may be created with the same name.
Craig Citro065b5302014-08-14 00:47:23 -0700135
136Args:
137 topic: string, Name of the topic to delete. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700138 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800139 Allowed values
140 1 - v1 error format
141 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700142
143Returns:
144 An object of the form:
145
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700146 { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800147}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700148</div>
149
150<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700151 <code class="details" id="get">get(topic, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700152 <pre>Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.
Craig Citro065b5302014-08-14 00:47:23 -0700153
154Args:
155 topic: string, The name of the topic to get. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700156 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800157 Allowed values
158 1 - v1 error format
159 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700160
161Returns:
162 An object of the form:
163
164 { # A topic resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
166}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700167</div>
168
169<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800170 <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700171 <pre>Lists matching topics.
172
173Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800174 maxResults: integer, Maximum number of topics to return.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800175 pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800176 query: string, A valid label query expression.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700177 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800178 Allowed values
179 1 - v1 error format
180 2 - v2 error format
Craig Citro065b5302014-08-14 00:47:23 -0700181
182Returns:
183 An object of the form:
184
Craig Citroe633be12015-03-02 13:40:36 -0800185 { # Response for the ListTopics method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800186 &quot;nextPageToken&quot;: &quot;A String&quot;, # If not empty, indicates that there are more topics that match the request, and this value should be passed to the next ListTopicsRequest to continue.
187 &quot;topic&quot;: [ # The resulting topics.
188 { # A topic resource.
189 &quot;name&quot;: &quot;A String&quot;, # Name of the topic.
190 },
191 ],
192}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700193</div>
194
195<div class="method">
196 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
197 <pre>Retrieves the next page of results.
198
199Args:
200 previous_request: The request for the previous page. (required)
201 previous_response: The response from the request for the previous page. (required)
202
203Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700204 A request object that you can call &#x27;execute()&#x27; on to request the next
Craig Citro065b5302014-08-14 00:47:23 -0700205 page. Returns None if there are no more items in the collection.
206 </pre>
207</div>
208
209<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700210 <code class="details" id="publish">publish(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700211 <pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
Craig Citro065b5302014-08-14 00:47:23 -0700212
213Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700214 body: object, The request body.
Craig Citro065b5302014-08-14 00:47:23 -0700215 The object takes the form of:
216
Craig Citroe633be12015-03-02 13:40:36 -0800217{ # Request for the Publish method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800218 &quot;message&quot;: { # A message data and its labels. # The message to publish.
219 &quot;data&quot;: &quot;A String&quot;, # The message payload.
220 &quot;label&quot;: [ # Optional list of labels for this message. Keys in this collection must be unique.
221 { # A key-value pair applied to a given object.
222 &quot;key&quot;: &quot;A String&quot;, # The key of a label is a syntactically valid URL (as per RFC 1738) with the &quot;scheme&quot; and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The &quot;host&quot; portion is called the &quot;namespace&quot; 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 &quot;/&quot; kpath kpath = ksegment *[ &quot;/&quot; ksegment ] ksegment = alphadigit | *[ alphadigit | &quot;-&quot; | &quot;_&quot; | &quot;.&quot; ] where &quot;hostname&quot; and &quot;alphadigit&quot; are defined as in RFC 1738. Example key: spanner.google.com/universe
223 &quot;numValue&quot;: &quot;A String&quot;, # An integer value.
224 &quot;strValue&quot;: &quot;A String&quot;, # A string value.
225 },
226 ],
227 &quot;messageId&quot;: &quot;A String&quot;, # 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.
228 &quot;publishTime&quot;: &quot;A String&quot;, # The time at which the message was published. The time is milliseconds since the UNIX epoch.
229 },
230 &quot;topic&quot;: &quot;A String&quot;, # The message in the request will be published on this topic.
231}
Craig Citro065b5302014-08-14 00:47:23 -0700232
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700233 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700237
238Returns:
239 An object of the form:
240
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700241 { # An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance: service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; }; BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that 1) The generated message here is in proto2 C++ API. 2) The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies) END GOOGLE-INTERNAL
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800242}</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700243</div>
244
Craig Citroe633be12015-03-02 13:40:36 -0800245<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700246 <code class="details" id="publishBatch">publishBatch(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700247 <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
Craig Citroe633be12015-03-02 13:40:36 -0800248
249Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700250 body: object, The request body.
Craig Citroe633be12015-03-02 13:40:36 -0800251 The object takes the form of:
252
253{ # Request for the PublishBatch method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800254 &quot;messages&quot;: [ # The messages to publish.
255 { # A message data and its labels.
256 &quot;data&quot;: &quot;A String&quot;, # The message payload.
257 &quot;label&quot;: [ # Optional list of labels for this message. Keys in this collection must be unique.
258 { # A key-value pair applied to a given object.
259 &quot;key&quot;: &quot;A String&quot;, # The key of a label is a syntactically valid URL (as per RFC 1738) with the &quot;scheme&quot; and initial slashes omitted and with the additional restrictions noted below. Each key should be globally unique. The &quot;host&quot; portion is called the &quot;namespace&quot; 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 &quot;/&quot; kpath kpath = ksegment *[ &quot;/&quot; ksegment ] ksegment = alphadigit | *[ alphadigit | &quot;-&quot; | &quot;_&quot; | &quot;.&quot; ] where &quot;hostname&quot; and &quot;alphadigit&quot; are defined as in RFC 1738. Example key: spanner.google.com/universe
260 &quot;numValue&quot;: &quot;A String&quot;, # An integer value.
261 &quot;strValue&quot;: &quot;A String&quot;, # A string value.
262 },
263 ],
264 &quot;messageId&quot;: &quot;A String&quot;, # 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.
265 &quot;publishTime&quot;: &quot;A String&quot;, # The time at which the message was published. The time is milliseconds since the UNIX epoch.
266 },
267 ],
268 &quot;topic&quot;: &quot;A String&quot;, # The messages in the request will be published on this topic.
269}
Craig Citroe633be12015-03-02 13:40:36 -0800270
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700271 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800272 Allowed values
273 1 - v1 error format
274 2 - v2 error format
Craig Citroe633be12015-03-02 13:40:36 -0800275
276Returns:
277 An object of the form:
278
279 { # Response for the PublishBatch method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800280 &quot;messageIds&quot;: [ # 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.
281 &quot;A String&quot;,
282 ],
283}</pre>
Craig Citroe633be12015-03-02 13:40:36 -0800284</div>
285
Craig Citro065b5302014-08-14 00:47:23 -0700286</body></html>