Blame - docs/dyn/pubsub_v1beta1a.subscriptions.html - platform/external/python/google-api-python-client

2014-08-14 00:47:23 -0700

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

75

<h1><a href="pubsub_v1beta1a.html">Cloud Pub/Sub API</a> . <a href="pubsub_v1beta1a.subscriptions.html">subscriptions</a></h1>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<code><a href="#acknowledge">acknowledge(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

79

<p class="firstline">Acknowledges a particular received message: the Pub/Sub system can remove</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

80

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

82

<p class="firstline">Creates a subscription on a given topic for a given subscriber.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

83

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

84

<code><a href="#delete">delete(subscription, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

85

<p class="firstline">Deletes an existing subscription. All pending messages in the subscription</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

86

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

87

<code><a href="#get">get(subscription, x__xgafv=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

88

<p class="firstline">Gets the configuration details of a subscription.</p>

89

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

90

<code><a href="#list">list(pageToken=None, maxResults=None, query=None, x__xgafv=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

91

<p class="firstline">Lists matching subscriptions.</p>

92

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code><a href="#modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</a></code></p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

97

<p class="firstline">Modifies the Ack deadline for a message received from a pull request.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

100

<p class="firstline">Modifies the <code>PushConfig</code> for a specified subscription.</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#pull">pull(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

103

<p class="firstline">Pulls a single message from the server.</p>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#pullBatch">pullBatch(body=None, x__xgafv=None)</a></code></p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

106

<p class="firstline">Pulls messages from the server. Returns an empty list if there are no</p>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

107

<h3>Method Details</h3>

108

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

<code class="details" id="acknowledge">acknowledge(body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

110

<pre>Acknowledges a particular received message: the Pub/Sub system can remove

111

the given message from the subscription. Acknowledging a message whose

112

Ack deadline has expired may succeed, but the message could have been

113

already redelivered. Acknowledging a message more than once will not

114

result in an error. This is only used for messages received via pull.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

115

116

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

118

The object takes the form of:

119

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

120

{ # Request for the Acknowledge method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

121

"subscription": "A String", # The subscription whose message is being acknowledged.

122

"ackId": [ # The acknowledgment ID for the message being acknowledged. This was

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

123

# returned by the Pub/Sub system in the Pull response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

125

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

126

}

127

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

128

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

129

Allowed values

130

1 - v1 error format

131

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

132

133

Returns:

134

An object of the form:

135

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

136

{ # An empty message that you can re-use to avoid defining duplicated empty

137

# messages in your project. A typical example is to use it as argument or the

138

# return value of a service API. For instance:

139

#

140

# service Foo {

141

# rpc Bar (proto2.Empty) returns (proto2.Empty) { };

142

# };

143

#

144

# BEGIN GOOGLE-INTERNAL

145

# The difference between this one and net/rpc/empty-message.proto is that

146

# 1) The generated message here is in proto2 C++ API.

147

# 2) The proto2.Empty has minimum dependencies

148

# (no message_set or net/rpc dependencies)

149

# END GOOGLE-INTERNAL

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

150

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

154

<code class="details" id="create">create(body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

155

<pre>Creates a subscription on a given topic for a given subscriber.

156

If the subscription already exists, returns ALREADY_EXISTS.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

157

If the corresponding topic doesn't exist, returns NOT_FOUND.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

158

159

If the name is not provided in the request, the server will assign a random

160

name for this subscription on the same project as the topic.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

161

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

162

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

163

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

164

The object takes the form of:

165

166

{ # A subscription resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

167

"ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

168

# subscriber receives a message before the subscriber should acknowledge or

169

# Nack the message. If the Ack deadline for a message passes without an

170

# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.

171

# If a subscriber acknowledges after the deadline, the Pub/Sub system may

172

# accept the Ack, but it is possible that the message has been already

173

# delivered again. Multiple Acks to the message are allowed and will

174

# succeed.

175

#

176

# For push delivery, this value is used to set the request timeout for

177

# the call to the push endpoint.

178

#

179

# For pull delivery, this value is used as the initial value for the Ack

180

# deadline. It may be overridden for each message using its corresponding

181

# ack_id with <code>ModifyAckDeadline</code>.

182

# While a message is outstanding (i.e. it has been delivered to a pull

183

# subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub

184

# system will not deliver that message to another pull subscriber

185

# (on a best-effort basis).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

186

"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is

187

# used to configure it.

188

"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.

189

# For example, a Webhook endpoint might use "https://example.com/push".

190

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

191

"name": "A String", # Name of the subscription.

192

"topic": "A String", # The name of the topic from which this subscription is receiving messages.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

193

}

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

194

195

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

202

203

{ # A subscription resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

204

"ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

205

# subscriber receives a message before the subscriber should acknowledge or

206

# Nack the message. If the Ack deadline for a message passes without an

207

# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.

208

# If a subscriber acknowledges after the deadline, the Pub/Sub system may

209

# accept the Ack, but it is possible that the message has been already

210

# delivered again. Multiple Acks to the message are allowed and will

211

# succeed.

212

#

213

# For push delivery, this value is used to set the request timeout for

214

# the call to the push endpoint.

215

#

216

# For pull delivery, this value is used as the initial value for the Ack

217

# deadline. It may be overridden for each message using its corresponding

218

# ack_id with <code>ModifyAckDeadline</code>.

219

# While a message is outstanding (i.e. it has been delivered to a pull

220

# subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub

221

# system will not deliver that message to another pull subscriber

222

# (on a best-effort basis).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

223

"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is

224

# used to configure it.

225

"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.

226

# For example, a Webhook endpoint might use "https://example.com/push".

227

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

228

"name": "A String", # Name of the subscription.

229

"topic": "A String", # The name of the topic from which this subscription is receiving messages.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

230

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

234

<code class="details" id="delete">delete(subscription, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

235

<pre>Deletes an existing subscription. All pending messages in the subscription

236

are immediately dropped. Calls to Pull after deletion will return

237

NOT_FOUND.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

238

239

Args:

240

subscription: string, The subscription to delete. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

241

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

242

Allowed values

243

1 - v1 error format

244

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

245

246

Returns:

247

An object of the form:

248

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

249

{ # An empty message that you can re-use to avoid defining duplicated empty

250

# messages in your project. A typical example is to use it as argument or the

251

# return value of a service API. For instance:

252

#

253

# service Foo {

254

# rpc Bar (proto2.Empty) returns (proto2.Empty) { };

255

# };

256

#

257

# BEGIN GOOGLE-INTERNAL

258

# The difference between this one and net/rpc/empty-message.proto is that

259

# 1) The generated message here is in proto2 C++ API.

260

# 2) The proto2.Empty has minimum dependencies

261

# (no message_set or net/rpc dependencies)

262

# END GOOGLE-INTERNAL

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

263

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

267

<code class="details" id="get">get(subscription, x__xgafv=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

268

<pre>Gets the configuration details of a subscription.

269

270

Args:

271

subscription: string, The name of the subscription to get. (required)

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

272

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

273

Allowed values

274

1 - v1 error format

275

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

276

277

Returns:

278

An object of the form:

279

280

{ # A subscription resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

281

"ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

282

# subscriber receives a message before the subscriber should acknowledge or

283

# Nack the message. If the Ack deadline for a message passes without an

284

# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.

285

# If a subscriber acknowledges after the deadline, the Pub/Sub system may

286

# accept the Ack, but it is possible that the message has been already

287

# delivered again. Multiple Acks to the message are allowed and will

288

# succeed.

289

#

290

# For push delivery, this value is used to set the request timeout for

291

# the call to the push endpoint.

292

#

293

# For pull delivery, this value is used as the initial value for the Ack

294

# deadline. It may be overridden for each message using its corresponding

295

# ack_id with <code>ModifyAckDeadline</code>.

296

# While a message is outstanding (i.e. it has been delivered to a pull

297

# subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub

298

# system will not deliver that message to another pull subscriber

299

# (on a best-effort basis).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

300

"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is

301

# used to configure it.

302

"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.

303

# For example, a Webhook endpoint might use "https://example.com/push".

304

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

305

"name": "A String", # Name of the subscription.

306

"topic": "A String", # The name of the topic from which this subscription is receiving messages.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

307

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

311

<code class="details" id="list">list(pageToken=None, maxResults=None, query=None, x__xgafv=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

312

<pre>Lists matching subscriptions.

313

314

Args:

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

315

pageToken: string, The value obtained in the last <code>ListSubscriptionsResponse</code>

316

for continuation.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

317

maxResults: integer, Maximum number of subscriptions to return.

318

query: string, A valid label query expression.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

319

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

320

Allowed values

321

1 - v1 error format

322

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

323

324

Returns:

325

An object of the form:

326

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

327

{ # Response for the ListSubscriptions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

328

"subscription": [ # The subscriptions that match the request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

329

{ # A subscription resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

330

"ackDeadlineSeconds": 42, # For either push or pull delivery, the value is the maximum time after a

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

331

# subscriber receives a message before the subscriber should acknowledge or

332

# Nack the message. If the Ack deadline for a message passes without an

333

# Ack or a Nack, the Pub/Sub system will eventually redeliver the message.

334

# If a subscriber acknowledges after the deadline, the Pub/Sub system may

335

# accept the Ack, but it is possible that the message has been already

336

# delivered again. Multiple Acks to the message are allowed and will

337

# succeed.

338

#

339

# For push delivery, this value is used to set the request timeout for

340

# the call to the push endpoint.

341

#

342

# For pull delivery, this value is used as the initial value for the Ack

343

# deadline. It may be overridden for each message using its corresponding

344

# ack_id with <code>ModifyAckDeadline</code>.

345

# While a message is outstanding (i.e. it has been delivered to a pull

346

# subscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub

347

# system will not deliver that message to another pull subscriber

348

# (on a best-effort basis).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

349

"pushConfig": { # Configuration for a push delivery endpoint. # If push delivery is used with this subscription, this field is

350

# used to configure it.

351

"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.

352

# For example, a Webhook endpoint might use "https://example.com/push".

353

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

354

"name": "A String", # Name of the subscription.

355

"topic": "A String", # The name of the topic from which this subscription is receiving messages.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

356

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

357

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

358

"nextPageToken": "A String", # If not empty, indicates that there are more subscriptions that match the

359

# request and this value should be passed to the next

360

# <code>ListSubscriptionsRequest</code> to continue.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

366

<pre>Retrieves the next page of results.

367

368

Args:

369

previous_request: The request for the previous page. (required)

370

previous_response: The response from the request for the previous page. (required)

371

372

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

373

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

374

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

379

<code class="details" id="modifyAckDeadline">modifyAckDeadline(body=None, x__xgafv=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

380

<pre>Modifies the Ack deadline for a message received from a pull request.

381

382

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

383

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

384

The object takes the form of:

385

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

386

{ # Request for the ModifyAckDeadline method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

387

"ackId": "A String", # The acknowledgment ID. Either this or ack_ids must be populated,

388

# not both.

389

"ackDeadlineSeconds": 42, # The new ack deadline with respect to the time this request was sent to the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

390

# Pub/Sub system. Must be >= 0. For example, if the value is 10, the new ack

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

391

# deadline will expire 10 seconds after the ModifyAckDeadline call was made.

392

# Specifying zero may immediately make the message available for another pull

393

# request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

394

"subscription": "A String", # Next Index: 5

395

# The name of the subscription from which messages are being pulled.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

396

"ackIds": [ # List of acknowledgment IDs. Either this field or ack_id

397

# should be populated, not both.

398

"A String",

399

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

400

}

401

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

402

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

403

Allowed values

404

1 - v1 error format

405

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

406

407

Returns:

408

An object of the form:

409

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

410

{ # An empty message that you can re-use to avoid defining duplicated empty

411

# messages in your project. A typical example is to use it as argument or the

412

# return value of a service API. For instance:

413

#

414

# service Foo {

415

# rpc Bar (proto2.Empty) returns (proto2.Empty) { };

416

# };

417

#

418

# BEGIN GOOGLE-INTERNAL

419

# The difference between this one and net/rpc/empty-message.proto is that

420

# 1) The generated message here is in proto2 C++ API.

421

# 2) The proto2.Empty has minimum dependencies

422

# (no message_set or net/rpc dependencies)

423

# END GOOGLE-INTERNAL

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

424

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

428

<code class="details" id="modifyPushConfig">modifyPushConfig(body=None, x__xgafv=None)</code>

429

<pre>Modifies the <code>PushConfig</code> for a specified subscription.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

430

This method can be used to suspend the flow of messages to an endpoint

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

431

by clearing the <code>PushConfig</code> field in the request. Messages

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

432

will be accumulated for delivery even if no push configuration is

433

defined or while the configuration is modified.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

434

435

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

436

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

437

The object takes the form of:

438

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

439

{ # Request for the ModifyPushConfig method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

440

"pushConfig": { # Configuration for a push delivery endpoint. # An empty <code>push_config</code> indicates that the Pub/Sub system should

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

441

# pause pushing messages from the given subscription.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

"pushEndpoint": "A String", # A URL locating the endpoint to which messages should be pushed.

443

# For example, a Webhook endpoint might use "https://example.com/push".

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

444

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

445

"subscription": "A String", # The name of the subscription.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

446

}

447

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

448

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

449

Allowed values

450

1 - v1 error format

451

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

452

453

Returns:

454

An object of the form:

455

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

456

{ # An empty message that you can re-use to avoid defining duplicated empty

457

# messages in your project. A typical example is to use it as argument or the

458

# return value of a service API. For instance:

459

#

460

# service Foo {

461

# rpc Bar (proto2.Empty) returns (proto2.Empty) { };

462

# };

463

#

464

# BEGIN GOOGLE-INTERNAL

465

# The difference between this one and net/rpc/empty-message.proto is that

466

# 1) The generated message here is in proto2 C++ API.

467

# 2) The proto2.Empty has minimum dependencies

468

# (no message_set or net/rpc dependencies)

469

# END GOOGLE-INTERNAL

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

470

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

474

<code class="details" id="pull">pull(body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

475

<pre>Pulls a single message from the server.

476

If return_immediately is true, and no messages are available in the

477

subscription, this method returns FAILED_PRECONDITION. The system is free

478

to return an UNAVAILABLE error if no messages are available in a

479

reasonable amount of time (to reduce system load).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

480

481

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

482

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

483

The object takes the form of:

484

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

485

{ # Request for the Pull method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

"returnImmediately": True or False, # If this is specified as true the system will respond immediately even if

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

487

# it is not able to return a message in the Pull response. Otherwise the

488

# system is allowed to wait until at least one message is available rather

489

# than returning FAILED_PRECONDITION. The client may cancel the request if

490

# it does not wish to wait any longer for the response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

491

"subscription": "A String", # The subscription from which a message should be pulled.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

492

}

493

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

494

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

495

Allowed values

496

1 - v1 error format

497

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

498

499

Returns:

500

An object of the form:

501

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

502

{ # Either a <code>PubsubMessage</code> or a truncation event. One of these two

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

503

# must be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

504

"pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

505

"subscription": "A String", # The subscription that received the event.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

506

"deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull

507

# subscribers will always receive NOT_FOUND in response in their pull

508

# request on the subscription, rather than seeing this boolean.)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

509

"message": { # A message data and its labels. # A received message.

510

"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed

511

# to be unique within the topic. This value may be read by a subscriber

512

# that receives a PubsubMessage via a Pull call or a push delivery. It must

513

# not be populated by a publisher in a Publish call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

514

"data": "A String", # The message payload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

515

"publishTime": "A String", # The time at which the message was published.

516

# The time is milliseconds since the UNIX epoch.

517

"label": [ # Optional list of labels for this message. Keys in this collection must

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

518

# be unique.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

519

{ # A key-value pair applied to a given object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

520

"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with

521

# the "scheme" and initial slashes omitted and with the additional

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

522

# restrictions noted below. Each key should be globally unique. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

523

# "host" portion is called the "namespace" and is not necessarily

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

524

# resolvable to a network endpoint. Instead, the namespace indicates what

525

# system or entity defines the semantics of the label. Namespaces do not

526

# restrict the set of objects to which a label may be associated.

527

#

528

# Keys are defined by the following grammar:

529

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

530

# key = hostname "/" kpath

531

# kpath = ksegment *[ "/" ksegment ]

532

# ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

533

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

534

# where "hostname" and "alphadigit" are defined as in RFC 1738.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

535

#

536

# Example key:

537

# spanner.google.com/universe

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

538

"strValue": "A String", # A string value.

539

"numValue": "A String", # An integer value.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

540

},

541

],

542

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

543

"truncated": True or False, # Indicates that this subscription has been truncated.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

544

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

545

"ackId": "A String", # This ID must be used to acknowledge the received event or message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

549

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

550

<code class="details" id="pullBatch">pullBatch(body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

551

<pre>Pulls messages from the server. Returns an empty list if there are no

552

messages available in the backlog. The system is free to return UNAVAILABLE

553

if there are too many pull requests outstanding for the given subscription.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

554

555

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

556

body: object, The request body.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

557

The object takes the form of:

558

559

{ # Request for the PullBatch method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

560

"subscription": "A String", # The subscription from which messages should be pulled.

561

"returnImmediately": True or False, # If this is specified as true the system will respond immediately even if

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

562

# it is not able to return a message in the Pull response. Otherwise the

563

# system is allowed to wait until at least one message is available rather

564

# than returning no messages. The client may cancel the request if it does

565

# not wish to wait any longer for the response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

566

"maxEvents": 42, # The maximum number of PubsubEvents returned for this request. The Pub/Sub

567

# system may return fewer than the number of events specified.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

568

}

569

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

570

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

571

Allowed values

572

1 - v1 error format

573

2 - v2 error format

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

574

575

Returns:

576

An object of the form:

577

578

{ # Response for the PullBatch method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

579

"pullResponses": [ # Received Pub/Sub messages or status events. The Pub/Sub system will return

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

580

# zero messages if there are no more messages available in the backlog. The

581

# Pub/Sub system may return fewer than the max_events requested even if

582

# there are more messages available in the backlog.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

583

{ # Either a <code>PubsubMessage</code> or a truncation event. One of these two

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

584

# must be populated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

585

"pubsubEvent": { # An event indicating a received message or truncation event. # A pubsub message or truncation event.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

586

"subscription": "A String", # The subscription that received the event.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

587

"deleted": True or False, # Indicates that this subscription has been deleted. (Note that pull

588

# subscribers will always receive NOT_FOUND in response in their pull

589

# request on the subscription, rather than seeing this boolean.)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

590

"message": { # A message data and its labels. # A received message.

591

"messageId": "A String", # ID of this message assigned by the server at publication time. Guaranteed

592

# to be unique within the topic. This value may be read by a subscriber

593

# that receives a PubsubMessage via a Pull call or a push delivery. It must

594

# not be populated by a publisher in a Publish call.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

595

"data": "A String", # The message payload.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

596

"publishTime": "A String", # The time at which the message was published.

597

# The time is milliseconds since the UNIX epoch.

598

"label": [ # Optional list of labels for this message. Keys in this collection must

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

599

# be unique.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

600

{ # A key-value pair applied to a given object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

601

"key": "A String", # The key of a label is a syntactically valid URL (as per RFC 1738) with

602

# the "scheme" and initial slashes omitted and with the additional

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

603

# restrictions noted below. Each key should be globally unique. The

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

604

# "host" portion is called the "namespace" and is not necessarily

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

605

# resolvable to a network endpoint. Instead, the namespace indicates what

606

# system or entity defines the semantics of the label. Namespaces do not

607

# restrict the set of objects to which a label may be associated.

608

#

609

# Keys are defined by the following grammar:

610

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

611

# key = hostname "/" kpath

612

# kpath = ksegment *[ "/" ksegment ]

613

# ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." ]

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

614

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

615

# where "hostname" and "alphadigit" are defined as in RFC 1738.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

616

#

617

# Example key:

618

# spanner.google.com/universe

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

619

"strValue": "A String", # A string value.

620

"numValue": "A String", # An integer value.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

621

},

622

],

623

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

624

"truncated": True or False, # Indicates that this subscription has been truncated.

Craig Citro

2015-03-02 13:40:36 -0800

[diff] [blame]

625

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

626

"ackId": "A String", # This ID must be used to acknowledge the received event or message.

Craig Citro