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 75<h1><a href="pubsub_v1beta1a.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.topics.html">topics</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates the given topic with the given name.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(topic, x__xgafv=None)</a></code></p> 85<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> 86<p class="toc_element"> 87 <code><a href="#get">get(topic, x__xgafv=None)</a></code></p> 88<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> 89<p class="toc_element"> 90 <code><a href="#list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p> 91<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"> 96 <code><a href="#publish">publish(body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.</p> 98<p class="toc_element"> 99 <code><a href="#publishBatch">publishBatch(body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="close">close()</code> 104 <pre>Close httplib2 connections.</pre> 105</div> 106 107<div class="method"> 108 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 109 <pre>Creates the given topic with the given name. 110 111Args: 112 body: object, The request body. 113 The object takes the form of: 114 115{ # A topic resource. 116 "name": "A String", # Name of the topic. 117} 118 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # A topic resource. 128 "name": "A String", # Name of the topic. 129}</pre> 130</div> 131 132<div class="method"> 133 <code class="details" id="delete">delete(topic, x__xgafv=None)</code> 134 <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. 135 136Args: 137 topic: string, Name of the topic to delete. (required) 138 x__xgafv: string, V1 error format. 139 Allowed values 140 1 - v1 error format 141 2 - v2 error format 142 143Returns: 144 An object of the form: 145 146 { # 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 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="get">get(topic, x__xgafv=None)</code> 152 <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. 153 154Args: 155 topic: string, The name of the topic to get. (required) 156 x__xgafv: string, V1 error format. 157 Allowed values 158 1 - v1 error format 159 2 - v2 error format 160 161Returns: 162 An object of the form: 163 164 { # A topic resource. 165 "name": "A String", # Name of the topic. 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code> 171 <pre>Lists matching topics. 172 173Args: 174 maxResults: integer, Maximum number of topics to return. 175 pageToken: string, The value obtained in the last ListTopicsResponse for continuation. 176 query: string, A valid label query expression. 177 x__xgafv: string, V1 error format. 178 Allowed values 179 1 - v1 error format 180 2 - v2 error format 181 182Returns: 183 An object of the form: 184 185 { # Response for the ListTopics method. 186 "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. 187 "topic": [ # The resulting topics. 188 { # A topic resource. 189 "name": "A String", # Name of the topic. 190 }, 191 ], 192}</pre> 193</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: 204 A request object that you can call 'execute()' on to request the next 205 page. Returns None if there are no more items in the collection. 206 </pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="publish">publish(body=None, x__xgafv=None)</code> 211 <pre>Adds a message to the topic. Returns NOT_FOUND if the topic does not exist. 212 213Args: 214 body: object, The request body. 215 The object takes the form of: 216 217{ # Request for the Publish method. 218 "message": { # A message data and its labels. # The message to publish. 219 "data": "A String", # The message payload. 220 "label": [ # 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 "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 223 "numValue": "A String", # An integer value. 224 "strValue": "A String", # A string value. 225 }, 226 ], 227 "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. 228 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch. 229 }, 230 "topic": "A String", # The message in the request will be published on this topic. 231} 232 233 x__xgafv: string, V1 error format. 234 Allowed values 235 1 - v1 error format 236 2 - v2 error format 237 238Returns: 239 An object of the form: 240 241 { # 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 242}</pre> 243</div> 244 245<div class="method"> 246 <code class="details" id="publishBatch">publishBatch(body=None, x__xgafv=None)</code> 247 <pre>Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist. 248 249Args: 250 body: object, The request body. 251 The object takes the form of: 252 253{ # Request for the PublishBatch method. 254 "messages": [ # The messages to publish. 255 { # A message data and its labels. 256 "data": "A String", # The message payload. 257 "label": [ # 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 "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 260 "numValue": "A String", # An integer value. 261 "strValue": "A String", # A string value. 262 }, 263 ], 264 "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. 265 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch. 266 }, 267 ], 268 "topic": "A String", # The messages in the request will be published on this topic. 269} 270 271 x__xgafv: string, V1 error format. 272 Allowed values 273 1 - v1 error format 274 2 - v2 error format 275 276Returns: 277 An object of the form: 278 279 { # Response for the PublishBatch method. 280 "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. 281 "A String", 282 ], 283}</pre> 284</div> 285 286</body></html>