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