Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / df61397973d36909a46fc4c3bf0e006dbb69f79a / . / docs / dyn / pubsub_v1beta1a.topics.html
blob: 17132a634caf49d4913593e81db961b68692408d [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
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]75<h1><a href="pubsub_v1beta1a.html">Google 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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]78 <code><a href="#create">create(body, 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>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]82<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 -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>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]85<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>
86<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]87 <code><a href="#list">list(maxResults=None, pageToken=None, query=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">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]93 <code><a href="#publish">publish(body, x__xgafv=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]94<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 -0800[diff] [blame]95<p class="toc_element">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]96 <code><a href="#publishBatch">publishBatch(body, x__xgafv=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]97<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 -0700[diff] [blame]98<h3>Method Details</h3>
99<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]100 <code class="details" id="create">create(body, 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:
104 body: object, The request body. (required)
105 The object takes the form of:
106
107{ # A topic resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]108 "name": "A String", # Name of the topic.
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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]112
113Returns:
114 An object of the form:
115
116 { # A topic resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]117 "name": "A String", # Name of the topic.
118 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]119</div>
120
121<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]122 <code class="details" id="delete">delete(topic, x__xgafv=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]123 <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 -0700[diff] [blame]124
125Args:
126 topic: string, Name of the topic to delete. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]127 x__xgafv: string, V1 error format.
128
129Returns:
130 An object of the form:
131
132 { # 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
133 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]134</div>
135
136<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]137 <code class="details" id="get">get(topic, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 <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.
139
140Args:
141 topic: string, The name of the topic to get. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]142 x__xgafv: string, V1 error format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]143
144Returns:
145 An object of the form:
146
147 { # A topic resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]148 "name": "A String", # Name of the topic.
149 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]150</div>
151
152<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]153 <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]154 <pre>Lists matching topics.
155
156Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]157 maxResults: integer, Maximum number of topics to return.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]158 pageToken: string, The value obtained in the last ListTopicsResponse for continuation.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]159 query: string, A valid label query expression.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]160 x__xgafv: string, V1 error format.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]161
162Returns:
163 An object of the form:
164
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]165 { # Response for the ListTopics method.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 "topic": [ # The resulting topics.
167 { # A topic resource.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]168 "name": "A String", # Name of the topic.
169 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]170 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]171 "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 ListTopicsRequest to continue.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
177 <pre>Retrieves the next page of results.
178
179Args:
180 previous_request: The request for the previous page. (required)
181 previous_response: The response from the request for the previous page. (required)
182
183Returns:
184 A request object that you can call 'execute()' on to request the next
185 page. Returns None if there are no more items in the collection.
186 </pre>
187</div>
188
189<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]190 <code class="details" id="publish">publish(body, x__xgafv=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]191 <pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
192
193Args:
194 body: object, The request body. (required)
195 The object takes the form of:
196
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]197{ # Request for the Publish method.
198 "topic": "A String", # The message in the request will be published on this topic.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]199 "message": { # A message data and its labels. # The message to publish.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]200 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]201 "data": "A String", # The message payload.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]202 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]203 "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
204 { # A key-value pair applied to a given object.
205 "numValue": "A String", # An integer value.
206 "strValue": "A String", # A string value.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]207 "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 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 | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]208 },
209 ],
210 },
211 }
212
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]213 x__xgafv: string, V1 error format.
214
215Returns:
216 An object of the form:
217
218 { # 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
219 }</pre>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]220</div>
221
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]222<div class="method">
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]223 <code class="details" id="publishBatch">publishBatch(body, x__xgafv=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]224 <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
225
226Args:
227 body: object, The request body. (required)
228 The object takes the form of:
229
230{ # Request for the PublishBatch method.
231 "topic": "A String", # The messages in the request will be published on this topic.
232 "messages": [ # The messages to publish.
233 { # A message data and its labels.
234 "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.
235 "data": "A String", # The message payload.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]236 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]237 "label": [ # Optional list of labels for this message. Keys in this collection must be unique.
238 { # A key-value pair applied to a given object.
239 "numValue": "A String", # An integer value.
240 "strValue": "A String", # A string value.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]241 "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 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 | "-" | "_" | "." ] where "hostname" and "alphadigit" are defined as in RFC 1738. Example key: spanner.google.com/universe
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]242 },
243 ],
244 },
245 ],
246 }
247
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame^]248 x__xgafv: string, V1 error format.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]249
250Returns:
251 An object of the form:
252
253 { # Response for the PublishBatch method.
254 "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.
255 "A String",
256 ],
257 }</pre>
258</div>
259
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]260</body></html>