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.subscriptions.html">subscriptions</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#acknowledge">acknowledge(body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(subscription, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets the configuration details of a subscription.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists matching subscriptions.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Modifies the Ack deadline for a message received from a pull request.</p> 101<p class="toc_element"> 102 <code><a href="#modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.</p> 104<p class="toc_element"> 105 <code><a href="#pull">pull(body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).</p> 107<p class="toc_element"> 108 <code><a href="#pullBatch">pullBatch(body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="acknowledge">acknowledge(body=None, x__xgafv=None)</code> 113 <pre>Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull. 114 115Args: 116 body: object, The request body. 117 The object takes the form of: 118 119{ # Request for the Acknowledge method. 120 "ackId": [ # The acknowledgment ID for the message being acknowledged. This was returned by the Pub/Sub system in the Pull response. 121 "A String", 122 ], 123 "subscription": "A String", # The subscription whose message is being acknowledged. 124} 125 126 x__xgafv: string, V1 error format. 127 Allowed values 128 1 - v1 error format 129 2 - v2 error format 130 131Returns: 132 An object of the form: 133 134 { # 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 135}</pre> 136</div> 137 138<div class="method"> 139 <code class="details" id="close">close()</code> 140 <pre>Close httplib2 connections.</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="create">create(body=None, x__xgafv=None)</code> 145 <pre>Creates a subscription on a given topic for a given subscriber. If the subscription already exists, returns ALREADY_EXISTS. If the corresponding topic doesn't exist, returns NOT_FOUND. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic. 146 147Args: 148 body: object, The request body. 149 The object takes the form of: 150 151{ # A subscription resource. 152 "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). 153 "name": "A String", # Name of the subscription. 154 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. 155 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". 156 }, 157 "topic": "A String", # The name of the topic from which this subscription is receiving messages. 158} 159 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # A subscription resource. 169 "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). 170 "name": "A String", # Name of the subscription. 171 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. 172 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". 173 }, 174 "topic": "A String", # The name of the topic from which this subscription is receiving messages. 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="delete">delete(subscription, x__xgafv=None)</code> 180 <pre>Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. 181 182Args: 183 subscription: string, The subscription to delete. (required) 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # 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 193}</pre> 194</div> 195 196<div class="method"> 197 <code class="details" id="get">get(subscription, x__xgafv=None)</code> 198 <pre>Gets the configuration details of a subscription. 199 200Args: 201 subscription: string, The name of the subscription to get. (required) 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 207Returns: 208 An object of the form: 209 210 { # A subscription resource. 211 "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). 212 "name": "A String", # Name of the subscription. 213 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. 214 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". 215 }, 216 "topic": "A String", # The name of the topic from which this subscription is receiving messages. 217}</pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="list">list(maxResults=None, pageToken=None, query=None, x__xgafv=None)</code> 222 <pre>Lists matching subscriptions. 223 224Args: 225 maxResults: integer, Maximum number of subscriptions to return. 226 pageToken: string, The value obtained in the last ListSubscriptionsResponse for continuation. 227 query: string, A valid label query expression. 228 x__xgafv: string, V1 error format. 229 Allowed values 230 1 - v1 error format 231 2 - v2 error format 232 233Returns: 234 An object of the form: 235 236 { # Response for the ListSubscriptions method. 237 "nextPageToken": "A String", # If not empty, indicates that there are more subscriptions that match the request and this value should be passed to the next ListSubscriptionsRequest to continue. 238 "subscription": [ # The subscriptions that match the request. 239 { # A subscription resource. 240 "ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a subscriber receives a message before the subscriber should acknowledge or Nack the message. If the Ack deadline for a message passes without an Ack or a Nack, the Pub/Sub system will eventually redeliver the message. If a subscriber acknowledges after the deadline, the Pub/Sub system may accept the Ack, but it is possible that the message has been already delivered again. Multiple Acks to the message are allowed and will succeed. For push delivery, this value is used to set the request timeout for the call to the push endpoint. For pull delivery, this value is used as the initial value for the Ack deadline. It may be overridden for each message using its corresponding ack_id with ModifyAckDeadline. While a message is outstanding (i.e. it has been delivered to a pull subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub system will not deliver that message to another pull subscriber (on a best-effort basis). 241 "name": "A String", # Name of the subscription. 242 "pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is used to configure it. 243 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". 244 }, 245 "topic": "A String", # The name of the topic from which this subscription is receiving messages. 246 }, 247 ], 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 253 <pre>Retrieves the next page of results. 254 255Args: 256 previous_request: The request for the previous page. (required) 257 previous_response: The response from the request for the previous page. (required) 258 259Returns: 260 A request object that you can call 'execute()' on to request the next 261 page. Returns None if there are no more items in the collection. 262 </pre> 263</div> 264 265<div class="method"> 266 <code class="details" id="modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</code> 267 <pre>Modifies the Ack deadline for a message received from a pull request. 268 269Args: 270 body: object, The request body. 271 The object takes the form of: 272 273{ # Request for the ModifyAckDeadline method. 274 "ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack deadline will expire 10 seconds after the ModifyAckDeadline call was made. Specifying zero may immediately make the message available for another pull request. 275 "ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated, not both. 276 "ackIds": [ # List of acknowledgment IDs. Either this field or ack_id should be populated, not both. 277 "A String", 278 ], 279 "subscription": "A String", # Next Index: 5 The name of the subscription from which messages are being pulled. 280} 281 282 x__xgafv: string, V1 error format. 283 Allowed values 284 1 - v1 error format 285 2 - v2 error format 286 287Returns: 288 An object of the form: 289 290 { # 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 291}</pre> 292</div> 293 294<div class="method"> 295 <code class="details" id="modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</code> 296 <pre>Modifies the PushConfig for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the PushConfig field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified. 297 298Args: 299 body: object, The request body. 300 The object takes the form of: 301 302{ # Request for the ModifyPushConfig method. 303 "pushConfig": { # Configuration for a push delivery endpoint. # An empty push_config indicates that the Pub/Sub system should pause pushing messages from the given subscription. 304 "pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use "https://example.com/push". 305 }, 306 "subscription": "A String", # The name of the subscription. 307} 308 309 x__xgafv: string, V1 error format. 310 Allowed values 311 1 - v1 error format 312 2 - v2 error format 313 314Returns: 315 An object of the form: 316 317 { # 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 318}</pre> 319</div> 320 321<div class="method"> 322 <code class="details" id="pull">pull(body=None, x__xgafv=None)</code> 323 <pre>Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load). 324 325Args: 326 body: object, The request body. 327 The object takes the form of: 328 329{ # Request for the Pull method. 330 "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning FAILED_PRECONDITION. The client may cancel the request if it does not wish to wait any longer for the response. 331 "subscription": "A String", # The subscription from which a message should be pulled. 332} 333 334 x__xgafv: string, V1 error format. 335 Allowed values 336 1 - v1 error format 337 2 - v2 error format 338 339Returns: 340 An object of the form: 341 342 { # Either a PubsubMessage or a truncation event. One of these two must be populated. 343 "ackId": "A String", # This ID must be used to acknowledge the received event or message. 344 "pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event. 345 "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.) 346 "message": { # A message data and its labels. # A received message. 347 "data": "A String", # The message payload. 348 "label": [ # Optional list of labels for this message. Keys in this collection must be unique. 349 { # A key-value pair applied to a given object. 350 "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 351 "numValue": "A String", # An integer value. 352 "strValue": "A String", # A string value. 353 }, 354 ], 355 "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. 356 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch. 357 }, 358 "subscription": "A String", # The subscription that received the event. 359 "truncated": True or False, # Indicates that this subscription has been truncated. 360 }, 361}</pre> 362</div> 363 364<div class="method"> 365 <code class="details" id="pullBatch">pullBatch(body=None, x__xgafv=None)</code> 366 <pre>Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription. 367 368Args: 369 body: object, The request body. 370 The object takes the form of: 371 372{ # Request for the PullBatch method. 373 "maxEvents": 42, # The maximum number of PubsubEvents returned for this request. The Pub/Sub system may return fewer than the number of events specified. 374 "returnImmediately": True or False, # If this is specified as true the system will respond immediately even if it is not able to return a message in the Pull response. Otherwise the system is allowed to wait until at least one message is available rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response. 375 "subscription": "A String", # The subscription from which messages should be pulled. 376} 377 378 x__xgafv: string, V1 error format. 379 Allowed values 380 1 - v1 error format 381 2 - v2 error format 382 383Returns: 384 An object of the form: 385 386 { # Response for the PullBatch method. 387 "pullResponses": [ # Received Pub/Sub messages or status events. The Pub/Sub system will return zero messages if there are no more messages available in the backlog. The Pub/Sub system may return fewer than the max_events requested even if there are more messages available in the backlog. 388 { # Either a PubsubMessage or a truncation event. One of these two must be populated. 389 "ackId": "A String", # This ID must be used to acknowledge the received event or message. 390 "pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event. 391 "deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull subscribers will always receive NOT_FOUND in response in their pull request on the subscription, rather than seeing this boolean.) 392 "message": { # A message data and its labels. # A received message. 393 "data": "A String", # The message payload. 394 "label": [ # Optional list of labels for this message. Keys in this collection must be unique. 395 { # A key-value pair applied to a given object. 396 "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 397 "numValue": "A String", # An integer value. 398 "strValue": "A String", # A string value. 399 }, 400 ], 401 "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. 402 "publishTime": "A String", # The time at which the message was published. The time is milliseconds since the UNIX epoch. 403 }, 404 "subscription": "A String", # The subscription that received the event. 405 "truncated": True or False, # Indicates that this subscription has been truncated. 406 }, 407 }, 408 ], 409}</pre> 410</div> 411 412</body></html>