@maxim_mazurok/gapi.client.pubsublite-v1 0.0.20231111 → 0.0.20231124

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +1463 -2147
  2. package/package.json +6 -6
  3. package/readme.md +17 -13
  4. package/tests.ts +0 -282
  5. package/tsconfig.json +0 -18
  6. package/tslint.json +0 -6
package/index.d.ts CHANGED
@@ -9,2159 +9,1475 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://pubsublite.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20231111
12
+ // Revision: 20231124
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
- /** Load Pub/Sub Lite API v1 */
18
- function load(urlOrObject: "https://pubsublite.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
19
- /** @deprecated Please load APIs with discovery documents. */
20
- function load(name: "pubsublite", version: "v1"): Promise<void>;
21
- /** @deprecated Please load APIs with discovery documents. */
22
- function load(name: "pubsublite", version: "v1", callback: () => any): void;
17
+ /** Load Pub/Sub Lite API v1 */
18
+ function load(
19
+ urlOrObject: 'https://pubsublite.googleapis.com/$discovery/rest?version=v1'
20
+ ): Promise<void>;
21
+ /** @deprecated Please load APIs with discovery documents. */
22
+ function load(name: 'pubsublite', version: 'v1'): Promise<void>;
23
+ /** @deprecated Please load APIs with discovery documents. */
24
+ function load(name: 'pubsublite', version: 'v1', callback: () => any): void;
23
25
 
24
- namespace pubsublite {
25
- // tslint:disable-next-line:no-empty-interface
26
- interface CancelOperationRequest {
27
- }
28
- interface Capacity {
29
- /** Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. */
30
- publishMibPerSec?:
31
- number;
32
- /** Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. */
33
- subscribeMibPerSec?:
34
- number;
35
- }
36
- interface CommitCursorRequest {
37
- /** The new value for the committed cursor. */
38
- cursor?:
39
- Cursor;
40
- /** The partition for which to update the cursor. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions). */
41
- partition?:
42
- string;
43
- }
44
- // tslint:disable-next-line:no-empty-interface
45
- interface CommitCursorResponse {
46
- }
47
- interface ComputeHeadCursorRequest {
48
- /** Required. The partition for which we should compute the head cursor. */
49
- partition?:
50
- string;
51
- }
52
- interface ComputeHeadCursorResponse {
53
- /** The head cursor. */
54
- headCursor?:
55
- Cursor;
56
- }
57
- interface ComputeMessageStatsRequest {
58
- /**
59
- * The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will
60
- * retrieve all messages.
61
- */
62
- endCursor?:
63
- Cursor;
64
- /** Required. The partition for which we should compute message stats. */
65
- partition?:
66
- string;
67
- /** The inclusive start of the range. */
68
- startCursor?:
69
- Cursor;
70
- }
71
- interface ComputeMessageStatsResponse {
72
- /** The number of quota bytes accounted to these messages. */
73
- messageBytes?:
74
- string;
75
- /** The count of messages. */
76
- messageCount?:
77
- string;
78
- /**
79
- * The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be
80
- * unset if there are no messages.
81
- */
82
- minimumEventTime?:
83
- string;
84
- /**
85
- * The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there
86
- * are no messages.
87
- */
88
- minimumPublishTime?:
89
- string;
90
- }
91
- interface ComputeTimeCursorRequest {
92
- /** Required. The partition for which we should compute the cursor. */
93
- partition?:
94
- string;
95
- /** Required. The target publish or event time. Specifying a future time will return an unset cursor. */
96
- target?:
97
- TimeTarget;
98
- }
99
- interface ComputeTimeCursorResponse {
100
- /**
101
- * If present, the cursor references the first message with time greater than or equal to the specified target time. If such a message cannot be found, the cursor will be unset (i.e.
102
- * `cursor` is not present).
103
- */
104
- cursor?:
105
- Cursor;
106
- }
107
- interface Cursor {
108
- /** The offset of a message within a topic partition. Must be greater than or equal 0. */
109
- offset?:
110
- string;
111
- }
112
- interface DeliveryConfig {
113
- /** The DeliveryRequirement for this subscription. */
114
- deliveryRequirement?:
115
- string;
116
- }
117
- // tslint:disable-next-line:no-empty-interface
118
- interface Empty {
119
- }
120
- interface ExportConfig {
121
- /** Output only. The current state of the export, which may be different to the desired state due to errors. This field is output only. */
122
- currentState?:
123
- string;
124
- /**
125
- * Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub
126
- * service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like:
127
- * projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed.
128
- */
129
- deadLetterTopic?:
130
- string;
131
- /** The desired state of this export. Setting this to values other than `ACTIVE` and `PAUSED` will result in an error. */
132
- desiredState?:
133
- string;
134
- /** Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic. */
135
- pubsubConfig?:
136
- PubSubConfig;
137
- }
138
- interface ListOperationsResponse {
139
- /** The standard List next-page token. */
140
- nextPageToken?:
141
- string;
142
- /** A list of operations that matches the specified filter in the request. */
143
- operations?:
144
- Operation[];
145
- }
146
- interface ListPartitionCursorsResponse {
147
- /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
148
- nextPageToken?:
149
- string;
150
- /** The partition cursors from this request. */
151
- partitionCursors?:
152
- PartitionCursor[];
153
- }
154
- interface ListReservationsResponse {
155
- /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
156
- nextPageToken?:
157
- string;
158
- /** The list of reservation in the requested parent. The order of the reservations is unspecified. */
159
- reservations?:
160
- Reservation[];
161
- }
162
- interface ListReservationTopicsResponse {
163
- /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
164
- nextPageToken?:
165
- string;
166
- /** The names of topics attached to the reservation. The order of the topics is unspecified. */
167
- topics?:
168
- string[];
169
- }
170
- interface ListSubscriptionsResponse {
171
- /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
172
- nextPageToken?:
173
- string;
174
- /** The list of subscriptions in the requested parent. The order of the subscriptions is unspecified. */
175
- subscriptions?:
176
- Subscription[];
177
- }
178
- interface ListTopicsResponse {
179
- /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
180
- nextPageToken?:
181
- string;
182
- /** The list of topic in the requested parent. The order of the topics is unspecified. */
183
- topics?:
184
- Topic[];
185
- }
186
- interface ListTopicSubscriptionsResponse {
187
- /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
188
- nextPageToken?:
189
- string;
190
- /** The names of subscriptions attached to the topic. The order of the subscriptions is unspecified. */
191
- subscriptions?:
192
- string[];
193
- }
194
- interface Operation {
195
- /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
196
- done?:
197
- boolean;
198
- /** The error result of the operation in case of failure or cancellation. */
199
- error?:
200
- Status;
201
- /**
202
- * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
203
- * metadata. Any method that returns a long-running operation should document the metadata type, if any.
204
- */
205
- metadata?:
206
- { [P in string]: any };
207
- /**
208
- * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
209
- * with `operations/{unique_id}`.
210
- */
211
- name?:
212
- string;
213
- /**
214
- * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original
215
- * method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original
216
- * method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
217
- */
218
- response?:
219
- { [P in string]: any };
220
- }
221
- interface OperationMetadata {
222
- /** The time the operation was created. */
223
- createTime?:
224
- string;
225
- /** The time the operation finished running. Not set if the operation has not completed. */
226
- endTime?:
227
- string;
228
- /**
229
- * Resource path for the target of the operation. For example, targets of seeks are subscription resources, structured like:
230
- * projects/{project_number}/locations/{location}/subscriptions/{subscription_id}
231
- */
232
- target?:
233
- string;
234
- /** Name of the verb executed by the operation. */
235
- verb?:
236
- string;
237
- }
238
- interface PartitionConfig {
239
- /** The capacity configuration. */
240
- capacity?:
241
- Capacity;
242
- /**
243
- * The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not
244
- * guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity
245
- */
246
- count?:
247
- string;
248
- /**
249
- * DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard
250
- * partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the
251
- * range [1,4].
252
- */
253
- scale?:
254
- number;
255
- }
256
- interface PartitionCursor {
257
- /** The value of the cursor. */
258
- cursor?:
259
- Cursor;
260
- /** The partition this is for. */
261
- partition?:
262
- string;
263
- }
264
- interface PubSubConfig {
265
- /** The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed. */
266
- topic?:
267
- string;
268
- }
269
- interface Reservation {
270
- /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
271
- name?:
272
- string;
273
- /**
274
- * The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared
275
- * as using capacity from a Reservation will consume resources from this reservation instead of being charged individually.
276
- */
277
- throughputCapacity?:
278
- string;
279
- }
280
- interface ReservationConfig {
281
- /** The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
282
- throughputReservation?:
283
- string;
284
- }
285
- interface RetentionConfig {
286
- /** How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. */
287
- period?:
288
- string;
289
- /**
290
- * The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room
291
- * for newer ones, regardless of the value of `period`.
292
- */
293
- perPartitionBytes?:
294
- string;
295
- }
296
- interface SeekSubscriptionRequest {
297
- /** Seek to a named position with respect to the message backlog. */
298
- namedTarget?:
299
- string;
300
- /**
301
- * Seek to the first message whose publish or event time is greater than or equal to the specified query time. If no such message can be located, will seek to the end of the message
302
- * backlog.
303
- */
304
- timeTarget?:
305
- TimeTarget;
306
- }
307
- // tslint:disable-next-line:no-empty-interface
308
- interface SeekSubscriptionResponse {
309
- }
310
- interface Status {
311
- /** The status code, which should be an enum value of google.rpc.Code. */
312
- code?:
313
- number;
314
- /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
315
- details?:
316
- Array<{ [P in string]: any }>;
317
- /**
318
- * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
319
- * client.
320
- */
321
- message?:
322
- string;
323
- }
324
- interface Subscription {
325
- /** The settings for this subscription's message delivery. */
326
- deliveryConfig?:
327
- DeliveryConfig;
328
- /** If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination. */
329
- exportConfig?:
330
- ExportConfig;
331
- /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
332
- name?:
333
- string;
334
- /** The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
335
- topic?:
336
- string;
337
- }
338
- interface TimeTarget {
339
- /**
340
- * Request the cursor of the first message with event time greater than or equal to `event_time`. If messages are missing an event time, the publish time is used as a fallback. As
341
- * event times are user supplied, subsequent messages may have event times less than `event_time` and should be filtered by the client, if necessary.
342
- */
343
- eventTime?:
344
- string;
345
- /** Request the cursor of the first message with publish time greater than or equal to `publish_time`. All messages thereafter are guaranteed to have publish times >= `publish_time`. */
346
- publishTime?:
347
- string;
348
- }
349
- interface Topic {
350
- /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
351
- name?:
352
- string;
353
- /** The settings for this topic's partitions. */
354
- partitionConfig?:
355
- PartitionConfig;
356
- /** The settings for this topic's Reservation usage. */
357
- reservationConfig?:
358
- ReservationConfig;
359
- /** The settings for this topic's message retention. */
360
- retentionConfig?:
361
- RetentionConfig;
362
- }
363
- interface TopicPartitions {
364
- /** The number of partitions in the topic. */
365
- partitionCount?:
366
- string;
367
- }
368
- interface OperationsResource {
369
- /**
370
- * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
371
- * this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
372
- * operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
373
- * google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
374
- */
375
- cancel(request: {
376
- /** V1 error format. */
377
- "$.xgafv"?:
378
- string;
379
- /** OAuth access token. */
380
- access_token?:
381
- string;
382
- /** Data format for response. */
383
- alt?:
384
- string;
385
- /** JSONP */
386
- callback?:
387
- string;
388
- /** Selector specifying which fields to include in a partial response. */
389
- fields?:
390
- string;
391
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
392
- key?:
393
- string;
394
- /** The name of the operation resource to be cancelled. */
395
- name:
396
- string;
397
- /** OAuth 2.0 token for the current user. */
398
- oauth_token?:
399
- string;
400
- /** Returns response with indentations and line breaks. */
401
- prettyPrint?:
402
- boolean;
403
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
404
- quotaUser?:
405
- string;
406
- /** Upload protocol for media (e.g. "raw", "multipart"). */
407
- upload_protocol?:
408
- string;
409
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
410
- uploadType?:
411
- string;
412
- /** Request body */
413
- resource:
414
- CancelOperationRequest;
415
- }): Request<{}>;
416
- cancel(request: {
417
- /** V1 error format. */
418
- "$.xgafv"?:
419
- string;
420
- /** OAuth access token. */
421
- access_token?:
422
- string;
423
- /** Data format for response. */
424
- alt?:
425
- string;
426
- /** JSONP */
427
- callback?:
428
- string;
429
- /** Selector specifying which fields to include in a partial response. */
430
- fields?:
431
- string;
432
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
433
- key?:
434
- string;
435
- /** The name of the operation resource to be cancelled. */
436
- name:
437
- string;
438
- /** OAuth 2.0 token for the current user. */
439
- oauth_token?:
440
- string;
441
- /** Returns response with indentations and line breaks. */
442
- prettyPrint?:
443
- boolean;
444
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
445
- quotaUser?:
446
- string;
447
- /** Upload protocol for media (e.g. "raw", "multipart"). */
448
- upload_protocol?:
449
- string;
450
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
451
- uploadType?:
452
- string;
453
- },
454
- body: CancelOperationRequest): Request<{}>;
455
- /**
456
- * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
457
- * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
458
- */
459
- delete(request?: {
460
- /** V1 error format. */
461
- "$.xgafv"?:
462
- string;
463
- /** OAuth access token. */
464
- access_token?:
465
- string;
466
- /** Data format for response. */
467
- alt?:
468
- string;
469
- /** JSONP */
470
- callback?:
471
- string;
472
- /** Selector specifying which fields to include in a partial response. */
473
- fields?:
474
- string;
475
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
476
- key?:
477
- string;
478
- /** The name of the operation resource to be deleted. */
479
- name:
480
- string;
481
- /** OAuth 2.0 token for the current user. */
482
- oauth_token?:
483
- string;
484
- /** Returns response with indentations and line breaks. */
485
- prettyPrint?:
486
- boolean;
487
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
488
- quotaUser?:
489
- string;
490
- /** Upload protocol for media (e.g. "raw", "multipart"). */
491
- upload_protocol?:
492
- string;
493
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
494
- uploadType?:
495
- string;
496
- }): Request<{}>;
497
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
498
- get(request?: {
499
- /** V1 error format. */
500
- "$.xgafv"?:
501
- string;
502
- /** OAuth access token. */
503
- access_token?:
504
- string;
505
- /** Data format for response. */
506
- alt?:
507
- string;
508
- /** JSONP */
509
- callback?:
510
- string;
511
- /** Selector specifying which fields to include in a partial response. */
512
- fields?:
513
- string;
514
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
515
- key?:
516
- string;
517
- /** The name of the operation resource. */
518
- name:
519
- string;
520
- /** OAuth 2.0 token for the current user. */
521
- oauth_token?:
522
- string;
523
- /** Returns response with indentations and line breaks. */
524
- prettyPrint?:
525
- boolean;
526
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
527
- quotaUser?:
528
- string;
529
- /** Upload protocol for media (e.g. "raw", "multipart"). */
530
- upload_protocol?:
531
- string;
532
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
533
- uploadType?:
534
- string;
535
- }): Request<Operation>;
536
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
537
- list(request?: {
538
- /** V1 error format. */
539
- "$.xgafv"?:
540
- string;
541
- /** OAuth access token. */
542
- access_token?:
543
- string;
544
- /** Data format for response. */
545
- alt?:
546
- string;
547
- /** JSONP */
548
- callback?:
549
- string;
550
- /** Selector specifying which fields to include in a partial response. */
551
- fields?:
552
- string;
553
- /** The standard list filter. */
554
- filter?:
555
- string;
556
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
557
- key?:
558
- string;
559
- /** The name of the operation's parent resource. */
560
- name:
561
- string;
562
- /** OAuth 2.0 token for the current user. */
563
- oauth_token?:
564
- string;
565
- /** The standard list page size. */
566
- pageSize?:
567
- number;
568
- /** The standard list page token. */
569
- pageToken?:
570
- string;
571
- /** Returns response with indentations and line breaks. */
572
- prettyPrint?:
573
- boolean;
574
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
575
- quotaUser?:
576
- string;
577
- /** Upload protocol for media (e.g. "raw", "multipart"). */
578
- upload_protocol?:
579
- string;
580
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
581
- uploadType?:
582
- string;
583
- }): Request<ListOperationsResponse>;
584
- }
585
- interface TopicsResource {
586
- /** Lists the topics attached to the specified reservation. */
587
- list(request?: {
588
- /** V1 error format. */
589
- "$.xgafv"?:
590
- string;
591
- /** OAuth access token. */
592
- access_token?:
593
- string;
594
- /** Data format for response. */
595
- alt?:
596
- string;
597
- /** JSONP */
598
- callback?:
599
- string;
600
- /** Selector specifying which fields to include in a partial response. */
601
- fields?:
602
- string;
603
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
604
- key?:
605
- string;
606
- /** Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
607
- name:
608
- string;
609
- /** OAuth 2.0 token for the current user. */
610
- oauth_token?:
611
- string;
612
- /** The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the given reservation will be returned. */
613
- pageSize?:
614
- number;
615
- /**
616
- * A page token, received from a previous `ListReservationTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
617
- * `ListReservationTopics` must match the call that provided the page token.
618
- */
619
- pageToken?:
620
- string;
621
- /** Returns response with indentations and line breaks. */
622
- prettyPrint?:
623
- boolean;
624
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
625
- quotaUser?:
626
- string;
627
- /** Upload protocol for media (e.g. "raw", "multipart"). */
628
- upload_protocol?:
629
- string;
630
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
631
- uploadType?:
632
- string;
633
- }): Request<ListReservationTopicsResponse>;
634
- }
635
- interface ReservationsResource {
636
- /** Creates a new reservation. */
637
- create(request: {
638
- /** V1 error format. */
639
- "$.xgafv"?:
640
- string;
641
- /** OAuth access token. */
642
- access_token?:
643
- string;
644
- /** Data format for response. */
645
- alt?:
646
- string;
647
- /** JSONP */
648
- callback?:
649
- string;
650
- /** Selector specifying which fields to include in a partial response. */
651
- fields?:
652
- string;
653
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
654
- key?:
655
- string;
656
- /** OAuth 2.0 token for the current user. */
657
- oauth_token?:
658
- string;
659
- /** Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. */
660
- parent:
661
- string;
662
- /** Returns response with indentations and line breaks. */
663
- prettyPrint?:
664
- boolean;
665
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
666
- quotaUser?:
667
- string;
668
- /** Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`. */
669
- reservationId?:
670
- string;
671
- /** Upload protocol for media (e.g. "raw", "multipart"). */
672
- upload_protocol?:
673
- string;
674
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
675
- uploadType?:
676
- string;
677
- /** Request body */
678
- resource:
679
- Reservation;
680
- }): Request<Reservation>;
681
- create(request: {
682
- /** V1 error format. */
683
- "$.xgafv"?:
684
- string;
685
- /** OAuth access token. */
686
- access_token?:
687
- string;
688
- /** Data format for response. */
689
- alt?:
690
- string;
691
- /** JSONP */
692
- callback?:
693
- string;
694
- /** Selector specifying which fields to include in a partial response. */
695
- fields?:
696
- string;
697
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
698
- key?:
699
- string;
700
- /** OAuth 2.0 token for the current user. */
701
- oauth_token?:
702
- string;
703
- /** Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. */
704
- parent:
705
- string;
706
- /** Returns response with indentations and line breaks. */
707
- prettyPrint?:
708
- boolean;
709
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
710
- quotaUser?:
711
- string;
712
- /** Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`. */
713
- reservationId?:
714
- string;
715
- /** Upload protocol for media (e.g. "raw", "multipart"). */
716
- upload_protocol?:
717
- string;
718
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
719
- uploadType?:
720
- string;
721
- },
722
- body: Reservation): Request<Reservation>;
723
- /** Deletes the specified reservation. */
724
- delete(request?: {
725
- /** V1 error format. */
726
- "$.xgafv"?:
727
- string;
728
- /** OAuth access token. */
729
- access_token?:
730
- string;
731
- /** Data format for response. */
732
- alt?:
733
- string;
734
- /** JSONP */
735
- callback?:
736
- string;
737
- /** Selector specifying which fields to include in a partial response. */
738
- fields?:
739
- string;
740
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
741
- key?:
742
- string;
743
- /** Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
744
- name:
745
- string;
746
- /** OAuth 2.0 token for the current user. */
747
- oauth_token?:
748
- string;
749
- /** Returns response with indentations and line breaks. */
750
- prettyPrint?:
751
- boolean;
752
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
753
- quotaUser?:
754
- string;
755
- /** Upload protocol for media (e.g. "raw", "multipart"). */
756
- upload_protocol?:
757
- string;
758
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
759
- uploadType?:
760
- string;
761
- }): Request<{}>;
762
- /** Returns the reservation configuration. */
763
- get(request?: {
764
- /** V1 error format. */
765
- "$.xgafv"?:
766
- string;
767
- /** OAuth access token. */
768
- access_token?:
769
- string;
770
- /** Data format for response. */
771
- alt?:
772
- string;
773
- /** JSONP */
774
- callback?:
775
- string;
776
- /** Selector specifying which fields to include in a partial response. */
777
- fields?:
778
- string;
779
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
780
- key?:
781
- string;
782
- /** Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
783
- name:
784
- string;
785
- /** OAuth 2.0 token for the current user. */
786
- oauth_token?:
787
- string;
788
- /** Returns response with indentations and line breaks. */
789
- prettyPrint?:
790
- boolean;
791
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
792
- quotaUser?:
793
- string;
794
- /** Upload protocol for media (e.g. "raw", "multipart"). */
795
- upload_protocol?:
796
- string;
797
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
798
- uploadType?:
799
- string;
800
- }): Request<Reservation>;
801
- /** Returns the list of reservations for the given project. */
802
- list(request?: {
803
- /** V1 error format. */
804
- "$.xgafv"?:
805
- string;
806
- /** OAuth access token. */
807
- access_token?:
808
- string;
809
- /** Data format for response. */
810
- alt?:
811
- string;
812
- /** JSONP */
813
- callback?:
814
- string;
815
- /** Selector specifying which fields to include in a partial response. */
816
- fields?:
817
- string;
818
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
819
- key?:
820
- string;
821
- /** OAuth 2.0 token for the current user. */
822
- oauth_token?:
823
- string;
824
- /** The maximum number of reservations to return. The service may return fewer than this value. If unset or zero, all reservations for the parent will be returned. */
825
- pageSize?:
826
- number;
827
- /**
828
- * A page token, received from a previous `ListReservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
829
- * `ListReservations` must match the call that provided the page token.
830
- */
831
- pageToken?:
832
- string;
833
- /** Required. The parent whose reservations are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
834
- parent:
835
- string;
836
- /** Returns response with indentations and line breaks. */
837
- prettyPrint?:
838
- boolean;
839
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
840
- quotaUser?:
841
- string;
842
- /** Upload protocol for media (e.g. "raw", "multipart"). */
843
- upload_protocol?:
844
- string;
845
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
846
- uploadType?:
847
- string;
848
- }): Request<ListReservationsResponse>;
849
- /** Updates properties of the specified reservation. */
850
- patch(request: {
851
- /** V1 error format. */
852
- "$.xgafv"?:
853
- string;
854
- /** OAuth access token. */
855
- access_token?:
856
- string;
857
- /** Data format for response. */
858
- alt?:
859
- string;
860
- /** JSONP */
861
- callback?:
862
- string;
863
- /** Selector specifying which fields to include in a partial response. */
864
- fields?:
865
- string;
866
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
867
- key?:
868
- string;
869
- /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
870
- name:
871
- string;
872
- /** OAuth 2.0 token for the current user. */
873
- oauth_token?:
874
- string;
875
- /** Returns response with indentations and line breaks. */
876
- prettyPrint?:
877
- boolean;
878
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
879
- quotaUser?:
880
- string;
881
- /** Required. A mask specifying the reservation fields to change. */
882
- updateMask?:
883
- string;
884
- /** Upload protocol for media (e.g. "raw", "multipart"). */
885
- upload_protocol?:
886
- string;
887
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
888
- uploadType?:
889
- string;
890
- /** Request body */
891
- resource:
892
- Reservation;
893
- }): Request<Reservation>;
894
- patch(request: {
895
- /** V1 error format. */
896
- "$.xgafv"?:
897
- string;
898
- /** OAuth access token. */
899
- access_token?:
900
- string;
901
- /** Data format for response. */
902
- alt?:
903
- string;
904
- /** JSONP */
905
- callback?:
906
- string;
907
- /** Selector specifying which fields to include in a partial response. */
908
- fields?:
909
- string;
910
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
911
- key?:
912
- string;
913
- /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
914
- name:
915
- string;
916
- /** OAuth 2.0 token for the current user. */
917
- oauth_token?:
918
- string;
919
- /** Returns response with indentations and line breaks. */
920
- prettyPrint?:
921
- boolean;
922
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
923
- quotaUser?:
924
- string;
925
- /** Required. A mask specifying the reservation fields to change. */
926
- updateMask?:
927
- string;
928
- /** Upload protocol for media (e.g. "raw", "multipart"). */
929
- upload_protocol?:
930
- string;
931
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
932
- uploadType?:
933
- string;
934
- },
935
- body: Reservation): Request<Reservation>;
936
- topics:
937
- TopicsResource;
938
- }
939
- interface SubscriptionsResource {
940
- /** Creates a new subscription. */
941
- create(request: {
942
- /** V1 error format. */
943
- "$.xgafv"?:
944
- string;
945
- /** OAuth access token. */
946
- access_token?:
947
- string;
948
- /** Data format for response. */
949
- alt?:
950
- string;
951
- /** JSONP */
952
- callback?:
953
- string;
954
- /** Selector specifying which fields to include in a partial response. */
955
- fields?:
956
- string;
957
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
958
- key?:
959
- string;
960
- /** OAuth 2.0 token for the current user. */
961
- oauth_token?:
962
- string;
963
- /** Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. */
964
- parent:
965
- string;
966
- /** Returns response with indentations and line breaks. */
967
- prettyPrint?:
968
- boolean;
969
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
970
- quotaUser?:
971
- string;
972
- /**
973
- * If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the
974
- * subscription. Defaults to false.
975
- */
976
- skipBacklog?:
977
- boolean;
978
- /** Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`. */
979
- subscriptionId?:
980
- string;
981
- /** Upload protocol for media (e.g. "raw", "multipart"). */
982
- upload_protocol?:
983
- string;
984
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
985
- uploadType?:
986
- string;
987
- /** Request body */
988
- resource:
989
- Subscription;
990
- }): Request<Subscription>;
991
- create(request: {
992
- /** V1 error format. */
993
- "$.xgafv"?:
994
- string;
995
- /** OAuth access token. */
996
- access_token?:
997
- string;
998
- /** Data format for response. */
999
- alt?:
1000
- string;
1001
- /** JSONP */
1002
- callback?:
1003
- string;
1004
- /** Selector specifying which fields to include in a partial response. */
1005
- fields?:
1006
- string;
1007
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1008
- key?:
1009
- string;
1010
- /** OAuth 2.0 token for the current user. */
1011
- oauth_token?:
1012
- string;
1013
- /** Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. */
1014
- parent:
1015
- string;
1016
- /** Returns response with indentations and line breaks. */
1017
- prettyPrint?:
1018
- boolean;
1019
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1020
- quotaUser?:
1021
- string;
1022
- /**
1023
- * If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the
1024
- * subscription. Defaults to false.
1025
- */
1026
- skipBacklog?:
1027
- boolean;
1028
- /** Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`. */
1029
- subscriptionId?:
1030
- string;
1031
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1032
- upload_protocol?:
1033
- string;
1034
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1035
- uploadType?:
1036
- string;
1037
- },
1038
- body: Subscription): Request<Subscription>;
1039
- /** Deletes the specified subscription. */
1040
- delete(request?: {
1041
- /** V1 error format. */
1042
- "$.xgafv"?:
1043
- string;
1044
- /** OAuth access token. */
1045
- access_token?:
1046
- string;
1047
- /** Data format for response. */
1048
- alt?:
1049
- string;
1050
- /** JSONP */
1051
- callback?:
1052
- string;
1053
- /** Selector specifying which fields to include in a partial response. */
1054
- fields?:
1055
- string;
1056
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1057
- key?:
1058
- string;
1059
- /** Required. The name of the subscription to delete. */
1060
- name:
1061
- string;
1062
- /** OAuth 2.0 token for the current user. */
1063
- oauth_token?:
1064
- string;
1065
- /** Returns response with indentations and line breaks. */
1066
- prettyPrint?:
1067
- boolean;
1068
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1069
- quotaUser?:
1070
- string;
1071
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1072
- upload_protocol?:
1073
- string;
1074
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1075
- uploadType?:
1076
- string;
1077
- }): Request<{}>;
1078
- /** Returns the subscription configuration. */
1079
- get(request?: {
1080
- /** V1 error format. */
1081
- "$.xgafv"?:
1082
- string;
1083
- /** OAuth access token. */
1084
- access_token?:
1085
- string;
1086
- /** Data format for response. */
1087
- alt?:
1088
- string;
1089
- /** JSONP */
1090
- callback?:
1091
- string;
1092
- /** Selector specifying which fields to include in a partial response. */
1093
- fields?:
1094
- string;
1095
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1096
- key?:
1097
- string;
1098
- /** Required. The name of the subscription whose configuration to return. */
1099
- name:
1100
- string;
1101
- /** OAuth 2.0 token for the current user. */
1102
- oauth_token?:
1103
- string;
1104
- /** Returns response with indentations and line breaks. */
1105
- prettyPrint?:
1106
- boolean;
1107
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1108
- quotaUser?:
1109
- string;
1110
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1111
- upload_protocol?:
1112
- string;
1113
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1114
- uploadType?:
1115
- string;
1116
- }): Request<Subscription>;
1117
- /** Returns the list of subscriptions for the given project. */
1118
- list(request?: {
1119
- /** V1 error format. */
1120
- "$.xgafv"?:
1121
- string;
1122
- /** OAuth access token. */
1123
- access_token?:
1124
- string;
1125
- /** Data format for response. */
1126
- alt?:
1127
- string;
1128
- /** JSONP */
1129
- callback?:
1130
- string;
1131
- /** Selector specifying which fields to include in a partial response. */
1132
- fields?:
1133
- string;
1134
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1135
- key?:
1136
- string;
1137
- /** OAuth 2.0 token for the current user. */
1138
- oauth_token?:
1139
- string;
1140
- /** The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned. */
1141
- pageSize?:
1142
- number;
1143
- /**
1144
- * A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
1145
- * `ListSubscriptions` must match the call that provided the page token.
1146
- */
1147
- pageToken?:
1148
- string;
1149
- /** Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
1150
- parent:
1151
- string;
1152
- /** Returns response with indentations and line breaks. */
1153
- prettyPrint?:
1154
- boolean;
1155
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1156
- quotaUser?:
1157
- string;
1158
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1159
- upload_protocol?:
1160
- string;
1161
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1162
- uploadType?:
1163
- string;
1164
- }): Request<ListSubscriptionsResponse>;
1165
- /** Updates properties of the specified subscription. */
1166
- patch(request: {
1167
- /** V1 error format. */
1168
- "$.xgafv"?:
1169
- string;
1170
- /** OAuth access token. */
1171
- access_token?:
1172
- string;
1173
- /** Data format for response. */
1174
- alt?:
1175
- string;
1176
- /** JSONP */
1177
- callback?:
1178
- string;
1179
- /** Selector specifying which fields to include in a partial response. */
1180
- fields?:
1181
- string;
1182
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1183
- key?:
1184
- string;
1185
- /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
1186
- name:
1187
- string;
1188
- /** OAuth 2.0 token for the current user. */
1189
- oauth_token?:
1190
- string;
1191
- /** Returns response with indentations and line breaks. */
1192
- prettyPrint?:
1193
- boolean;
1194
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1195
- quotaUser?:
1196
- string;
1197
- /** Required. A mask specifying the subscription fields to change. */
1198
- updateMask?:
1199
- string;
1200
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1201
- upload_protocol?:
1202
- string;
1203
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1204
- uploadType?:
1205
- string;
1206
- /** Request body */
1207
- resource:
1208
- Subscription;
1209
- }): Request<Subscription>;
1210
- patch(request: {
1211
- /** V1 error format. */
1212
- "$.xgafv"?:
1213
- string;
1214
- /** OAuth access token. */
1215
- access_token?:
1216
- string;
1217
- /** Data format for response. */
1218
- alt?:
1219
- string;
1220
- /** JSONP */
1221
- callback?:
1222
- string;
1223
- /** Selector specifying which fields to include in a partial response. */
1224
- fields?:
1225
- string;
1226
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1227
- key?:
1228
- string;
1229
- /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
1230
- name:
1231
- string;
1232
- /** OAuth 2.0 token for the current user. */
1233
- oauth_token?:
1234
- string;
1235
- /** Returns response with indentations and line breaks. */
1236
- prettyPrint?:
1237
- boolean;
1238
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1239
- quotaUser?:
1240
- string;
1241
- /** Required. A mask specifying the subscription fields to change. */
1242
- updateMask?:
1243
- string;
1244
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1245
- upload_protocol?:
1246
- string;
1247
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1248
- uploadType?:
1249
- string;
1250
- },
1251
- body: Subscription): Request<Subscription>;
1252
- /**
1253
- * Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to
1254
- * cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and
1255
- * subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system
1256
- * that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when
1257
- * subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek
1258
- * cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet
1259
- * completed, it will be aborted and the new invocation of seek will supersede it.
1260
- */
1261
- seek(request: {
1262
- /** V1 error format. */
1263
- "$.xgafv"?:
1264
- string;
1265
- /** OAuth access token. */
1266
- access_token?:
1267
- string;
1268
- /** Data format for response. */
1269
- alt?:
1270
- string;
1271
- /** JSONP */
1272
- callback?:
1273
- string;
1274
- /** Selector specifying which fields to include in a partial response. */
1275
- fields?:
1276
- string;
1277
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1278
- key?:
1279
- string;
1280
- /** Required. The name of the subscription to seek. */
1281
- name:
1282
- string;
1283
- /** OAuth 2.0 token for the current user. */
1284
- oauth_token?:
1285
- string;
1286
- /** Returns response with indentations and line breaks. */
1287
- prettyPrint?:
1288
- boolean;
1289
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1290
- quotaUser?:
1291
- string;
1292
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1293
- upload_protocol?:
1294
- string;
1295
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1296
- uploadType?:
1297
- string;
1298
- /** Request body */
1299
- resource:
1300
- SeekSubscriptionRequest;
1301
- }): Request<Operation>;
1302
- seek(request: {
1303
- /** V1 error format. */
1304
- "$.xgafv"?:
1305
- string;
1306
- /** OAuth access token. */
1307
- access_token?:
1308
- string;
1309
- /** Data format for response. */
1310
- alt?:
1311
- string;
1312
- /** JSONP */
1313
- callback?:
1314
- string;
1315
- /** Selector specifying which fields to include in a partial response. */
1316
- fields?:
1317
- string;
1318
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1319
- key?:
1320
- string;
1321
- /** Required. The name of the subscription to seek. */
1322
- name:
1323
- string;
1324
- /** OAuth 2.0 token for the current user. */
1325
- oauth_token?:
1326
- string;
1327
- /** Returns response with indentations and line breaks. */
1328
- prettyPrint?:
1329
- boolean;
1330
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1331
- quotaUser?:
1332
- string;
1333
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1334
- upload_protocol?:
1335
- string;
1336
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1337
- uploadType?:
1338
- string;
1339
- },
1340
- body: SeekSubscriptionRequest): Request<Operation>;
1341
- }
1342
- interface SubscriptionsResource {
1343
- /** Lists the subscriptions attached to the specified topic. */
1344
- list(request?: {
1345
- /** V1 error format. */
1346
- "$.xgafv"?:
1347
- string;
1348
- /** OAuth access token. */
1349
- access_token?:
1350
- string;
1351
- /** Data format for response. */
1352
- alt?:
1353
- string;
1354
- /** JSONP */
1355
- callback?:
1356
- string;
1357
- /** Selector specifying which fields to include in a partial response. */
1358
- fields?:
1359
- string;
1360
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1361
- key?:
1362
- string;
1363
- /** Required. The name of the topic whose subscriptions to list. */
1364
- name:
1365
- string;
1366
- /** OAuth 2.0 token for the current user. */
1367
- oauth_token?:
1368
- string;
1369
- /** The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned. */
1370
- pageSize?:
1371
- number;
1372
- /**
1373
- * A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
1374
- * `ListTopicSubscriptions` must match the call that provided the page token.
1375
- */
1376
- pageToken?:
1377
- string;
1378
- /** Returns response with indentations and line breaks. */
1379
- prettyPrint?:
1380
- boolean;
1381
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1382
- quotaUser?:
1383
- string;
1384
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1385
- upload_protocol?:
1386
- string;
1387
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1388
- uploadType?:
1389
- string;
1390
- }): Request<ListTopicSubscriptionsResponse>;
1391
- }
1392
- interface TopicsResource {
1393
- /** Creates a new topic. */
1394
- create(request: {
1395
- /** V1 error format. */
1396
- "$.xgafv"?:
1397
- string;
1398
- /** OAuth access token. */
1399
- access_token?:
1400
- string;
1401
- /** Data format for response. */
1402
- alt?:
1403
- string;
1404
- /** JSONP */
1405
- callback?:
1406
- string;
1407
- /** Selector specifying which fields to include in a partial response. */
1408
- fields?:
1409
- string;
1410
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1411
- key?:
1412
- string;
1413
- /** OAuth 2.0 token for the current user. */
1414
- oauth_token?:
1415
- string;
1416
- /** Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. */
1417
- parent:
1418
- string;
1419
- /** Returns response with indentations and line breaks. */
1420
- prettyPrint?:
1421
- boolean;
1422
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1423
- quotaUser?:
1424
- string;
1425
- /** Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. */
1426
- topicId?:
1427
- string;
1428
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1429
- upload_protocol?:
1430
- string;
1431
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1432
- uploadType?:
1433
- string;
1434
- /** Request body */
1435
- resource:
1436
- Topic;
1437
- }): Request<Topic>;
1438
- create(request: {
1439
- /** V1 error format. */
1440
- "$.xgafv"?:
1441
- string;
1442
- /** OAuth access token. */
1443
- access_token?:
1444
- string;
1445
- /** Data format for response. */
1446
- alt?:
1447
- string;
1448
- /** JSONP */
1449
- callback?:
1450
- string;
1451
- /** Selector specifying which fields to include in a partial response. */
1452
- fields?:
1453
- string;
1454
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1455
- key?:
1456
- string;
1457
- /** OAuth 2.0 token for the current user. */
1458
- oauth_token?:
1459
- string;
1460
- /** Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. */
1461
- parent:
1462
- string;
1463
- /** Returns response with indentations and line breaks. */
1464
- prettyPrint?:
1465
- boolean;
1466
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1467
- quotaUser?:
1468
- string;
1469
- /** Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. */
1470
- topicId?:
1471
- string;
1472
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1473
- upload_protocol?:
1474
- string;
1475
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1476
- uploadType?:
1477
- string;
1478
- },
1479
- body: Topic): Request<Topic>;
1480
- /** Deletes the specified topic. */
1481
- delete(request?: {
1482
- /** V1 error format. */
1483
- "$.xgafv"?:
1484
- string;
1485
- /** OAuth access token. */
1486
- access_token?:
1487
- string;
1488
- /** Data format for response. */
1489
- alt?:
1490
- string;
1491
- /** JSONP */
1492
- callback?:
1493
- string;
1494
- /** Selector specifying which fields to include in a partial response. */
1495
- fields?:
1496
- string;
1497
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1498
- key?:
1499
- string;
1500
- /** Required. The name of the topic to delete. */
1501
- name:
1502
- string;
1503
- /** OAuth 2.0 token for the current user. */
1504
- oauth_token?:
1505
- string;
1506
- /** Returns response with indentations and line breaks. */
1507
- prettyPrint?:
1508
- boolean;
1509
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1510
- quotaUser?:
1511
- string;
1512
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1513
- upload_protocol?:
1514
- string;
1515
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1516
- uploadType?:
1517
- string;
1518
- }): Request<{}>;
1519
- /** Returns the topic configuration. */
1520
- get(request?: {
1521
- /** V1 error format. */
1522
- "$.xgafv"?:
1523
- string;
1524
- /** OAuth access token. */
1525
- access_token?:
1526
- string;
1527
- /** Data format for response. */
1528
- alt?:
1529
- string;
1530
- /** JSONP */
1531
- callback?:
1532
- string;
1533
- /** Selector specifying which fields to include in a partial response. */
1534
- fields?:
1535
- string;
1536
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1537
- key?:
1538
- string;
1539
- /** Required. The name of the topic whose configuration to return. */
1540
- name:
1541
- string;
1542
- /** OAuth 2.0 token for the current user. */
1543
- oauth_token?:
1544
- string;
1545
- /** Returns response with indentations and line breaks. */
1546
- prettyPrint?:
1547
- boolean;
1548
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1549
- quotaUser?:
1550
- string;
1551
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1552
- upload_protocol?:
1553
- string;
1554
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1555
- uploadType?:
1556
- string;
1557
- }): Request<Topic>;
1558
- /** Returns the partition information for the requested topic. */
1559
- getPartitions(request?: {
1560
- /** V1 error format. */
1561
- "$.xgafv"?:
1562
- string;
1563
- /** OAuth access token. */
1564
- access_token?:
1565
- string;
1566
- /** Data format for response. */
1567
- alt?:
1568
- string;
1569
- /** JSONP */
1570
- callback?:
1571
- string;
1572
- /** Selector specifying which fields to include in a partial response. */
1573
- fields?:
1574
- string;
1575
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1576
- key?:
1577
- string;
1578
- /** Required. The topic whose partition information to return. */
1579
- name:
1580
- string;
1581
- /** OAuth 2.0 token for the current user. */
1582
- oauth_token?:
1583
- string;
1584
- /** Returns response with indentations and line breaks. */
1585
- prettyPrint?:
1586
- boolean;
1587
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1588
- quotaUser?:
1589
- string;
1590
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1591
- upload_protocol?:
1592
- string;
1593
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1594
- uploadType?:
1595
- string;
1596
- }): Request<TopicPartitions>;
1597
- /** Returns the list of topics for the given project. */
1598
- list(request?: {
1599
- /** V1 error format. */
1600
- "$.xgafv"?:
1601
- string;
1602
- /** OAuth access token. */
1603
- access_token?:
1604
- string;
1605
- /** Data format for response. */
1606
- alt?:
1607
- string;
1608
- /** JSONP */
1609
- callback?:
1610
- string;
1611
- /** Selector specifying which fields to include in a partial response. */
1612
- fields?:
1613
- string;
1614
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1615
- key?:
1616
- string;
1617
- /** OAuth 2.0 token for the current user. */
1618
- oauth_token?:
1619
- string;
1620
- /** The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned. */
1621
- pageSize?:
1622
- number;
1623
- /**
1624
- * A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match
1625
- * the call that provided the page token.
1626
- */
1627
- pageToken?:
1628
- string;
1629
- /** Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
1630
- parent:
1631
- string;
1632
- /** Returns response with indentations and line breaks. */
1633
- prettyPrint?:
1634
- boolean;
1635
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1636
- quotaUser?:
1637
- string;
1638
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1639
- upload_protocol?:
1640
- string;
1641
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1642
- uploadType?:
1643
- string;
1644
- }): Request<ListTopicsResponse>;
1645
- /** Updates properties of the specified topic. */
1646
- patch(request: {
1647
- /** V1 error format. */
1648
- "$.xgafv"?:
1649
- string;
1650
- /** OAuth access token. */
1651
- access_token?:
1652
- string;
1653
- /** Data format for response. */
1654
- alt?:
1655
- string;
1656
- /** JSONP */
1657
- callback?:
1658
- string;
1659
- /** Selector specifying which fields to include in a partial response. */
1660
- fields?:
1661
- string;
1662
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1663
- key?:
1664
- string;
1665
- /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
1666
- name:
1667
- string;
1668
- /** OAuth 2.0 token for the current user. */
1669
- oauth_token?:
1670
- string;
1671
- /** Returns response with indentations and line breaks. */
1672
- prettyPrint?:
1673
- boolean;
1674
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1675
- quotaUser?:
1676
- string;
1677
- /** Required. A mask specifying the topic fields to change. */
1678
- updateMask?:
1679
- string;
1680
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1681
- upload_protocol?:
1682
- string;
1683
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1684
- uploadType?:
1685
- string;
1686
- /** Request body */
1687
- resource:
1688
- Topic;
1689
- }): Request<Topic>;
1690
- patch(request: {
1691
- /** V1 error format. */
1692
- "$.xgafv"?:
1693
- string;
1694
- /** OAuth access token. */
1695
- access_token?:
1696
- string;
1697
- /** Data format for response. */
1698
- alt?:
1699
- string;
1700
- /** JSONP */
1701
- callback?:
1702
- string;
1703
- /** Selector specifying which fields to include in a partial response. */
1704
- fields?:
1705
- string;
1706
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1707
- key?:
1708
- string;
1709
- /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
1710
- name:
1711
- string;
1712
- /** OAuth 2.0 token for the current user. */
1713
- oauth_token?:
1714
- string;
1715
- /** Returns response with indentations and line breaks. */
1716
- prettyPrint?:
1717
- boolean;
1718
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1719
- quotaUser?:
1720
- string;
1721
- /** Required. A mask specifying the topic fields to change. */
1722
- updateMask?:
1723
- string;
1724
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1725
- upload_protocol?:
1726
- string;
1727
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1728
- uploadType?:
1729
- string;
1730
- },
1731
- body: Topic): Request<Topic>;
1732
- subscriptions:
1733
- SubscriptionsResource;
1734
- }
1735
- interface LocationsResource {
1736
- operations:
1737
- OperationsResource;
1738
- reservations:
1739
- ReservationsResource;
1740
- subscriptions:
1741
- SubscriptionsResource;
1742
- topics:
1743
- TopicsResource;
1744
- }
1745
- interface ProjectsResource {
1746
- locations:
1747
- LocationsResource;
1748
- }
1749
- interface AdminResource {
1750
- projects:
1751
- ProjectsResource;
1752
- }
1753
- interface CursorsResource {
1754
- /** Returns all committed cursor information for a subscription. */
1755
- list(request?: {
1756
- /** V1 error format. */
1757
- "$.xgafv"?:
1758
- string;
1759
- /** OAuth access token. */
1760
- access_token?:
1761
- string;
1762
- /** Data format for response. */
1763
- alt?:
1764
- string;
1765
- /** JSONP */
1766
- callback?:
1767
- string;
1768
- /** Selector specifying which fields to include in a partial response. */
1769
- fields?:
1770
- string;
1771
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1772
- key?:
1773
- string;
1774
- /** OAuth 2.0 token for the current user. */
1775
- oauth_token?:
1776
- string;
1777
- /** The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned. */
1778
- pageSize?:
1779
- number;
1780
- /**
1781
- * A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
1782
- * `ListPartitionCursors` must match the call that provided the page token.
1783
- */
1784
- pageToken?:
1785
- string;
1786
- /** Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`. */
1787
- parent:
1788
- string;
1789
- /** Returns response with indentations and line breaks. */
1790
- prettyPrint?:
1791
- boolean;
1792
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1793
- quotaUser?:
1794
- string;
1795
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1796
- upload_protocol?:
1797
- string;
1798
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1799
- uploadType?:
1800
- string;
1801
- }): Request<ListPartitionCursorsResponse>;
1802
- }
1803
- interface SubscriptionsResource {
1804
- /** Updates the committed cursor. */
1805
- commitCursor(request: {
1806
- /** V1 error format. */
1807
- "$.xgafv"?:
1808
- string;
1809
- /** OAuth access token. */
1810
- access_token?:
1811
- string;
1812
- /** Data format for response. */
1813
- alt?:
1814
- string;
1815
- /** JSONP */
1816
- callback?:
1817
- string;
1818
- /** Selector specifying which fields to include in a partial response. */
1819
- fields?:
1820
- string;
1821
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1822
- key?:
1823
- string;
1824
- /** OAuth 2.0 token for the current user. */
1825
- oauth_token?:
1826
- string;
1827
- /** Returns response with indentations and line breaks. */
1828
- prettyPrint?:
1829
- boolean;
1830
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1831
- quotaUser?:
1832
- string;
1833
- /** The subscription for which to update the cursor. */
1834
- subscription:
1835
- string;
1836
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1837
- upload_protocol?:
1838
- string;
1839
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1840
- uploadType?:
1841
- string;
1842
- /** Request body */
1843
- resource:
1844
- CommitCursorRequest;
1845
- }): Request<{}>;
1846
- commitCursor(request: {
1847
- /** V1 error format. */
1848
- "$.xgafv"?:
1849
- string;
1850
- /** OAuth access token. */
1851
- access_token?:
1852
- string;
1853
- /** Data format for response. */
1854
- alt?:
1855
- string;
1856
- /** JSONP */
1857
- callback?:
1858
- string;
1859
- /** Selector specifying which fields to include in a partial response. */
1860
- fields?:
1861
- string;
1862
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1863
- key?:
1864
- string;
1865
- /** OAuth 2.0 token for the current user. */
1866
- oauth_token?:
1867
- string;
1868
- /** Returns response with indentations and line breaks. */
1869
- prettyPrint?:
1870
- boolean;
1871
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1872
- quotaUser?:
1873
- string;
1874
- /** The subscription for which to update the cursor. */
1875
- subscription:
1876
- string;
1877
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1878
- upload_protocol?:
1879
- string;
1880
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1881
- uploadType?:
1882
- string;
1883
- },
1884
- body: CommitCursorRequest): Request<{}>;
1885
- cursors:
1886
- CursorsResource;
1887
- }
1888
- interface LocationsResource {
1889
- subscriptions:
1890
- SubscriptionsResource;
1891
- }
1892
- interface ProjectsResource {
1893
- locations:
1894
- LocationsResource;
1895
- }
1896
- interface CursorResource {
1897
- projects:
1898
- ProjectsResource;
1899
- }
1900
- interface TopicsResource {
1901
- /**
1902
- * Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and
1903
- * greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.
1904
- */
1905
- computeHeadCursor(request: {
1906
- /** V1 error format. */
1907
- "$.xgafv"?:
1908
- string;
1909
- /** OAuth access token. */
1910
- access_token?:
1911
- string;
1912
- /** Data format for response. */
1913
- alt?:
1914
- string;
1915
- /** JSONP */
1916
- callback?:
1917
- string;
1918
- /** Selector specifying which fields to include in a partial response. */
1919
- fields?:
1920
- string;
1921
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1922
- key?:
1923
- string;
1924
- /** OAuth 2.0 token for the current user. */
1925
- oauth_token?:
1926
- string;
1927
- /** Returns response with indentations and line breaks. */
1928
- prettyPrint?:
1929
- boolean;
1930
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1931
- quotaUser?:
1932
- string;
1933
- /** Required. The topic for which we should compute the head cursor. */
1934
- topic:
1935
- string;
1936
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1937
- upload_protocol?:
1938
- string;
1939
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1940
- uploadType?:
1941
- string;
1942
- /** Request body */
1943
- resource:
1944
- ComputeHeadCursorRequest;
1945
- }): Request<ComputeHeadCursorResponse>;
1946
- computeHeadCursor(request: {
1947
- /** V1 error format. */
1948
- "$.xgafv"?:
1949
- string;
1950
- /** OAuth access token. */
1951
- access_token?:
1952
- string;
1953
- /** Data format for response. */
1954
- alt?:
1955
- string;
1956
- /** JSONP */
1957
- callback?:
1958
- string;
1959
- /** Selector specifying which fields to include in a partial response. */
1960
- fields?:
1961
- string;
1962
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1963
- key?:
1964
- string;
1965
- /** OAuth 2.0 token for the current user. */
1966
- oauth_token?:
1967
- string;
1968
- /** Returns response with indentations and line breaks. */
1969
- prettyPrint?:
1970
- boolean;
1971
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1972
- quotaUser?:
1973
- string;
1974
- /** Required. The topic for which we should compute the head cursor. */
1975
- topic:
1976
- string;
1977
- /** Upload protocol for media (e.g. "raw", "multipart"). */
1978
- upload_protocol?:
1979
- string;
1980
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1981
- uploadType?:
1982
- string;
1983
- },
1984
- body: ComputeHeadCursorRequest): Request<ComputeHeadCursorResponse>;
1985
- /** Compute statistics about a range of messages in a given topic and partition. */
1986
- computeMessageStats(request: {
1987
- /** V1 error format. */
1988
- "$.xgafv"?:
1989
- string;
1990
- /** OAuth access token. */
1991
- access_token?:
1992
- string;
1993
- /** Data format for response. */
1994
- alt?:
1995
- string;
1996
- /** JSONP */
1997
- callback?:
1998
- string;
1999
- /** Selector specifying which fields to include in a partial response. */
2000
- fields?:
2001
- string;
2002
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2003
- key?:
2004
- string;
2005
- /** OAuth 2.0 token for the current user. */
2006
- oauth_token?:
2007
- string;
2008
- /** Returns response with indentations and line breaks. */
2009
- prettyPrint?:
2010
- boolean;
2011
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2012
- quotaUser?:
2013
- string;
2014
- /** Required. The topic for which we should compute message stats. */
2015
- topic:
2016
- string;
2017
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2018
- upload_protocol?:
2019
- string;
2020
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2021
- uploadType?:
2022
- string;
2023
- /** Request body */
2024
- resource:
2025
- ComputeMessageStatsRequest;
2026
- }): Request<ComputeMessageStatsResponse>;
2027
- computeMessageStats(request: {
2028
- /** V1 error format. */
2029
- "$.xgafv"?:
2030
- string;
2031
- /** OAuth access token. */
2032
- access_token?:
2033
- string;
2034
- /** Data format for response. */
2035
- alt?:
2036
- string;
2037
- /** JSONP */
2038
- callback?:
2039
- string;
2040
- /** Selector specifying which fields to include in a partial response. */
2041
- fields?:
2042
- string;
2043
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2044
- key?:
2045
- string;
2046
- /** OAuth 2.0 token for the current user. */
2047
- oauth_token?:
2048
- string;
2049
- /** Returns response with indentations and line breaks. */
2050
- prettyPrint?:
2051
- boolean;
2052
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2053
- quotaUser?:
2054
- string;
2055
- /** Required. The topic for which we should compute message stats. */
2056
- topic:
2057
- string;
2058
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2059
- upload_protocol?:
2060
- string;
2061
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2062
- uploadType?:
2063
- string;
2064
- },
2065
- body: ComputeMessageStatsRequest): Request<ComputeMessageStatsResponse>;
2066
- /** Compute the corresponding cursor for a publish or event time in a topic partition. */
2067
- computeTimeCursor(request: {
2068
- /** V1 error format. */
2069
- "$.xgafv"?:
2070
- string;
2071
- /** OAuth access token. */
2072
- access_token?:
2073
- string;
2074
- /** Data format for response. */
2075
- alt?:
2076
- string;
2077
- /** JSONP */
2078
- callback?:
2079
- string;
2080
- /** Selector specifying which fields to include in a partial response. */
2081
- fields?:
2082
- string;
2083
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2084
- key?:
2085
- string;
2086
- /** OAuth 2.0 token for the current user. */
2087
- oauth_token?:
2088
- string;
2089
- /** Returns response with indentations and line breaks. */
2090
- prettyPrint?:
2091
- boolean;
2092
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2093
- quotaUser?:
2094
- string;
2095
- /** Required. The topic for which we should compute the cursor. */
2096
- topic:
2097
- string;
2098
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2099
- upload_protocol?:
2100
- string;
2101
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2102
- uploadType?:
2103
- string;
2104
- /** Request body */
2105
- resource:
2106
- ComputeTimeCursorRequest;
2107
- }): Request<ComputeTimeCursorResponse>;
2108
- computeTimeCursor(request: {
2109
- /** V1 error format. */
2110
- "$.xgafv"?:
2111
- string;
2112
- /** OAuth access token. */
2113
- access_token?:
2114
- string;
2115
- /** Data format for response. */
2116
- alt?:
2117
- string;
2118
- /** JSONP */
2119
- callback?:
2120
- string;
2121
- /** Selector specifying which fields to include in a partial response. */
2122
- fields?:
2123
- string;
2124
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2125
- key?:
2126
- string;
2127
- /** OAuth 2.0 token for the current user. */
2128
- oauth_token?:
2129
- string;
2130
- /** Returns response with indentations and line breaks. */
2131
- prettyPrint?:
2132
- boolean;
2133
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2134
- quotaUser?:
2135
- string;
2136
- /** Required. The topic for which we should compute the cursor. */
2137
- topic:
2138
- string;
2139
- /** Upload protocol for media (e.g. "raw", "multipart"). */
2140
- upload_protocol?:
2141
- string;
2142
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2143
- uploadType?:
2144
- string;
2145
- },
2146
- body: ComputeTimeCursorRequest): Request<ComputeTimeCursorResponse>;
2147
- }
2148
- interface LocationsResource {
2149
- topics:
2150
- TopicsResource;
2151
- }
2152
- interface ProjectsResource {
2153
- locations:
2154
- LocationsResource;
2155
- }
2156
- interface TopicStatsResource {
2157
- projects:
2158
- ProjectsResource;
2159
- }
26
+ namespace pubsublite {
27
+ interface CancelOperationRequest {}
28
+ interface Capacity {
29
+ /** Publish throughput capacity per partition in MiB/s. Must be >= 4 and <= 16. */
30
+ publishMibPerSec?: number;
31
+ /** Subscribe throughput capacity per partition in MiB/s. Must be >= 4 and <= 32. */
32
+ subscribeMibPerSec?: number;
33
+ }
34
+ interface CommitCursorRequest {
35
+ /** The new value for the committed cursor. */
36
+ cursor?: Cursor;
37
+ /** The partition for which to update the cursor. Partitions are zero indexed, so `partition` must be in the range [0, topic.num_partitions). */
38
+ partition?: string;
39
+ }
40
+ interface CommitCursorResponse {}
41
+ interface ComputeHeadCursorRequest {
42
+ /** Required. The partition for which we should compute the head cursor. */
43
+ partition?: string;
44
+ }
45
+ interface ComputeHeadCursorResponse {
46
+ /** The head cursor. */
47
+ headCursor?: Cursor;
48
+ }
49
+ interface ComputeMessageStatsRequest {
50
+ /** The exclusive end of the range. The range is empty if end_cursor <= start_cursor. Specifying a start_cursor before the first message and an end_cursor after the last message will retrieve all messages. */
51
+ endCursor?: Cursor;
52
+ /** Required. The partition for which we should compute message stats. */
53
+ partition?: string;
54
+ /** The inclusive start of the range. */
55
+ startCursor?: Cursor;
56
+ }
57
+ interface ComputeMessageStatsResponse {
58
+ /** The number of quota bytes accounted to these messages. */
59
+ messageBytes?: string;
60
+ /** The count of messages. */
61
+ messageCount?: string;
62
+ /** The minimum event timestamp across these messages. For the purposes of this computation, if a message does not have an event time, we use the publish time. The timestamp will be unset if there are no messages. */
63
+ minimumEventTime?: string;
64
+ /** The minimum publish timestamp across these messages. Note that publish timestamps within a partition are not guaranteed to be non-decreasing. The timestamp will be unset if there are no messages. */
65
+ minimumPublishTime?: string;
66
+ }
67
+ interface ComputeTimeCursorRequest {
68
+ /** Required. The partition for which we should compute the cursor. */
69
+ partition?: string;
70
+ /** Required. The target publish or event time. Specifying a future time will return an unset cursor. */
71
+ target?: TimeTarget;
72
+ }
73
+ interface ComputeTimeCursorResponse {
74
+ /** If present, the cursor references the first message with time greater than or equal to the specified target time. If such a message cannot be found, the cursor will be unset (i.e. `cursor` is not present). */
75
+ cursor?: Cursor;
76
+ }
77
+ interface Cursor {
78
+ /** The offset of a message within a topic partition. Must be greater than or equal 0. */
79
+ offset?: string;
80
+ }
81
+ interface DeliveryConfig {
82
+ /** The DeliveryRequirement for this subscription. */
83
+ deliveryRequirement?: string;
84
+ }
85
+ interface Empty {}
86
+ interface ExportConfig {
87
+ /** Output only. The current state of the export, which may be different to the desired state due to errors. This field is output only. */
88
+ currentState?: string;
89
+ /** Optional. The name of an optional Pub/Sub Lite topic to publish messages that can not be exported to the destination. For example, the message can not be published to the Pub/Sub service because it does not satisfy the constraints documented at https://cloud.google.com/pubsub/docs/publisher. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}. Must be within the same project and location as the subscription. The topic may be changed or removed. */
90
+ deadLetterTopic?: string;
91
+ /** The desired state of this export. Setting this to values other than `ACTIVE` and `PAUSED` will result in an error. */
92
+ desiredState?: string;
93
+ /** Messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a Pub/Sub topic. */
94
+ pubsubConfig?: PubSubConfig;
95
+ }
96
+ interface ListOperationsResponse {
97
+ /** The standard List next-page token. */
98
+ nextPageToken?: string;
99
+ /** A list of operations that matches the specified filter in the request. */
100
+ operations?: Operation[];
101
+ }
102
+ interface ListPartitionCursorsResponse {
103
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
104
+ nextPageToken?: string;
105
+ /** The partition cursors from this request. */
106
+ partitionCursors?: PartitionCursor[];
107
+ }
108
+ interface ListReservationsResponse {
109
+ /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
110
+ nextPageToken?: string;
111
+ /** The list of reservation in the requested parent. The order of the reservations is unspecified. */
112
+ reservations?: Reservation[];
113
+ }
114
+ interface ListReservationTopicsResponse {
115
+ /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
116
+ nextPageToken?: string;
117
+ /** The names of topics attached to the reservation. The order of the topics is unspecified. */
118
+ topics?: string[];
119
+ }
120
+ interface ListSubscriptionsResponse {
121
+ /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
122
+ nextPageToken?: string;
123
+ /** The list of subscriptions in the requested parent. The order of the subscriptions is unspecified. */
124
+ subscriptions?: Subscription[];
125
+ }
126
+ interface ListTopicsResponse {
127
+ /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
128
+ nextPageToken?: string;
129
+ /** The list of topic in the requested parent. The order of the topics is unspecified. */
130
+ topics?: Topic[];
131
+ }
132
+ interface ListTopicSubscriptionsResponse {
133
+ /** A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results. */
134
+ nextPageToken?: string;
135
+ /** The names of subscriptions attached to the topic. The order of the subscriptions is unspecified. */
136
+ subscriptions?: string[];
137
+ }
138
+ interface Operation {
139
+ /** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
140
+ done?: boolean;
141
+ /** The error result of the operation in case of failure or cancellation. */
142
+ error?: Status;
143
+ /** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
144
+ metadata?: {[P in string]: any};
145
+ /** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
146
+ name?: string;
147
+ /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
148
+ response?: {[P in string]: any};
149
+ }
150
+ interface OperationMetadata {
151
+ /** The time the operation was created. */
152
+ createTime?: string;
153
+ /** The time the operation finished running. Not set if the operation has not completed. */
154
+ endTime?: string;
155
+ /** Resource path for the target of the operation. For example, targets of seeks are subscription resources, structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
156
+ target?: string;
157
+ /** Name of the verb executed by the operation. */
158
+ verb?: string;
159
+ }
160
+ interface PartitionConfig {
161
+ /** The capacity configuration. */
162
+ capacity?: Capacity;
163
+ /** The number of partitions in the topic. Must be at least 1. Once a topic has been created the number of partitions can be increased but not decreased. Message ordering is not guaranteed across a topic resize. For more information see https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacity */
164
+ count?: string;
165
+ /** DEPRECATED: Use capacity instead which can express a superset of configurations. Every partition in the topic is allocated throughput equivalent to `scale` times the standard partition throughput (4 MiB/s). This is also reflected in the cost of this topic; a topic with `scale` of 2 and count of 10 is charged for 20 partitions. This value must be in the range [1,4]. */
166
+ scale?: number;
167
+ }
168
+ interface PartitionCursor {
169
+ /** The value of the cursor. */
170
+ cursor?: Cursor;
171
+ /** The partition this is for. */
172
+ partition?: string;
173
+ }
174
+ interface PubSubConfig {
175
+ /** The name of the Pub/Sub topic. Structured like: projects/{project_number}/topics/{topic_id}. The topic may be changed. */
176
+ topic?: string;
177
+ }
178
+ interface Reservation {
179
+ /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
180
+ name?: string;
181
+ /** The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages. Any topics which are declared as using capacity from a Reservation will consume resources from this reservation instead of being charged individually. */
182
+ throughputCapacity?: string;
183
+ }
184
+ interface ReservationConfig {
185
+ /** The Reservation to use for this topic's throughput capacity. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
186
+ throughputReservation?: string;
187
+ }
188
+ interface RetentionConfig {
189
+ /** How long a published message is retained. If unset, messages will be retained as long as the bytes retained for each partition is below `per_partition_bytes`. */
190
+ period?: string;
191
+ /** The provisioned storage, in bytes, per partition. If the number of bytes stored in any of the topic's partitions grows beyond this value, older messages will be dropped to make room for newer ones, regardless of the value of `period`. */
192
+ perPartitionBytes?: string;
193
+ }
194
+ interface SeekSubscriptionRequest {
195
+ /** Seek to a named position with respect to the message backlog. */
196
+ namedTarget?: string;
197
+ /** Seek to the first message whose publish or event time is greater than or equal to the specified query time. If no such message can be located, will seek to the end of the message backlog. */
198
+ timeTarget?: TimeTarget;
199
+ }
200
+ interface SeekSubscriptionResponse {}
201
+ interface Status {
202
+ /** The status code, which should be an enum value of google.rpc.Code. */
203
+ code?: number;
204
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
205
+ details?: Array<{[P in string]: any}>;
206
+ /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
207
+ message?: string;
208
+ }
209
+ interface Subscription {
210
+ /** The settings for this subscription's message delivery. */
211
+ deliveryConfig?: DeliveryConfig;
212
+ /** If present, messages are automatically written from the Pub/Sub Lite topic associated with this subscription to a destination. */
213
+ exportConfig?: ExportConfig;
214
+ /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
215
+ name?: string;
216
+ /** The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
217
+ topic?: string;
218
+ }
219
+ interface TimeTarget {
220
+ /** Request the cursor of the first message with event time greater than or equal to `event_time`. If messages are missing an event time, the publish time is used as a fallback. As event times are user supplied, subsequent messages may have event times less than `event_time` and should be filtered by the client, if necessary. */
221
+ eventTime?: string;
222
+ /** Request the cursor of the first message with publish time greater than or equal to `publish_time`. All messages thereafter are guaranteed to have publish times >= `publish_time`. */
223
+ publishTime?: string;
224
+ }
225
+ interface Topic {
226
+ /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
227
+ name?: string;
228
+ /** The settings for this topic's partitions. */
229
+ partitionConfig?: PartitionConfig;
230
+ /** The settings for this topic's Reservation usage. */
231
+ reservationConfig?: ReservationConfig;
232
+ /** The settings for this topic's message retention. */
233
+ retentionConfig?: RetentionConfig;
234
+ }
235
+ interface TopicPartitions {
236
+ /** The number of partitions in the topic. */
237
+ partitionCount?: string;
238
+ }
239
+ interface OperationsResource {
240
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
241
+ cancel(request: {
242
+ /** V1 error format. */
243
+ '$.xgafv'?: string;
244
+ /** OAuth access token. */
245
+ access_token?: string;
246
+ /** Data format for response. */
247
+ alt?: string;
248
+ /** JSONP */
249
+ callback?: string;
250
+ /** Selector specifying which fields to include in a partial response. */
251
+ fields?: string;
252
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
253
+ key?: string;
254
+ /** The name of the operation resource to be cancelled. */
255
+ name: string;
256
+ /** OAuth 2.0 token for the current user. */
257
+ oauth_token?: string;
258
+ /** Returns response with indentations and line breaks. */
259
+ prettyPrint?: boolean;
260
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
261
+ quotaUser?: string;
262
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
263
+ upload_protocol?: string;
264
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
265
+ uploadType?: string;
266
+ /** Request body */
267
+ resource: CancelOperationRequest;
268
+ }): Request<{}>;
269
+ cancel(
270
+ request: {
271
+ /** V1 error format. */
272
+ '$.xgafv'?: string;
273
+ /** OAuth access token. */
274
+ access_token?: string;
275
+ /** Data format for response. */
276
+ alt?: string;
277
+ /** JSONP */
278
+ callback?: string;
279
+ /** Selector specifying which fields to include in a partial response. */
280
+ fields?: string;
281
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
282
+ key?: string;
283
+ /** The name of the operation resource to be cancelled. */
284
+ name: string;
285
+ /** OAuth 2.0 token for the current user. */
286
+ oauth_token?: string;
287
+ /** Returns response with indentations and line breaks. */
288
+ prettyPrint?: boolean;
289
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
290
+ quotaUser?: string;
291
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
292
+ upload_protocol?: string;
293
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
294
+ uploadType?: string;
295
+ },
296
+ body: CancelOperationRequest
297
+ ): Request<{}>;
298
+ /** Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
299
+ delete(request?: {
300
+ /** V1 error format. */
301
+ '$.xgafv'?: string;
302
+ /** OAuth access token. */
303
+ access_token?: string;
304
+ /** Data format for response. */
305
+ alt?: string;
306
+ /** JSONP */
307
+ callback?: string;
308
+ /** Selector specifying which fields to include in a partial response. */
309
+ fields?: string;
310
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
311
+ key?: string;
312
+ /** The name of the operation resource to be deleted. */
313
+ name: string;
314
+ /** OAuth 2.0 token for the current user. */
315
+ oauth_token?: string;
316
+ /** Returns response with indentations and line breaks. */
317
+ prettyPrint?: boolean;
318
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
319
+ quotaUser?: string;
320
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
321
+ upload_protocol?: string;
322
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
323
+ uploadType?: string;
324
+ }): Request<{}>;
325
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
326
+ get(request?: {
327
+ /** V1 error format. */
328
+ '$.xgafv'?: string;
329
+ /** OAuth access token. */
330
+ access_token?: string;
331
+ /** Data format for response. */
332
+ alt?: string;
333
+ /** JSONP */
334
+ callback?: string;
335
+ /** Selector specifying which fields to include in a partial response. */
336
+ fields?: string;
337
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
338
+ key?: string;
339
+ /** The name of the operation resource. */
340
+ name: string;
341
+ /** OAuth 2.0 token for the current user. */
342
+ oauth_token?: string;
343
+ /** Returns response with indentations and line breaks. */
344
+ prettyPrint?: boolean;
345
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
346
+ quotaUser?: string;
347
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
348
+ upload_protocol?: string;
349
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
350
+ uploadType?: string;
351
+ }): Request<Operation>;
352
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
353
+ list(request?: {
354
+ /** V1 error format. */
355
+ '$.xgafv'?: string;
356
+ /** OAuth access token. */
357
+ access_token?: string;
358
+ /** Data format for response. */
359
+ alt?: string;
360
+ /** JSONP */
361
+ callback?: string;
362
+ /** Selector specifying which fields to include in a partial response. */
363
+ fields?: string;
364
+ /** The standard list filter. */
365
+ filter?: string;
366
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
367
+ key?: string;
368
+ /** The name of the operation's parent resource. */
369
+ name: string;
370
+ /** OAuth 2.0 token for the current user. */
371
+ oauth_token?: string;
372
+ /** The standard list page size. */
373
+ pageSize?: number;
374
+ /** The standard list page token. */
375
+ pageToken?: string;
376
+ /** Returns response with indentations and line breaks. */
377
+ prettyPrint?: boolean;
378
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
379
+ quotaUser?: string;
380
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
381
+ upload_protocol?: string;
382
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
383
+ uploadType?: string;
384
+ }): Request<ListOperationsResponse>;
385
+ }
386
+ interface TopicsResource {
387
+ /** Lists the topics attached to the specified reservation. */
388
+ list(request?: {
389
+ /** V1 error format. */
390
+ '$.xgafv'?: string;
391
+ /** OAuth access token. */
392
+ access_token?: string;
393
+ /** Data format for response. */
394
+ alt?: string;
395
+ /** JSONP */
396
+ callback?: string;
397
+ /** Selector specifying which fields to include in a partial response. */
398
+ fields?: string;
399
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
400
+ key?: string;
401
+ /** Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
402
+ name: string;
403
+ /** OAuth 2.0 token for the current user. */
404
+ oauth_token?: string;
405
+ /** The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the given reservation will be returned. */
406
+ pageSize?: number;
407
+ /** A page token, received from a previous `ListReservationTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservationTopics` must match the call that provided the page token. */
408
+ pageToken?: string;
409
+ /** Returns response with indentations and line breaks. */
410
+ prettyPrint?: boolean;
411
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
412
+ quotaUser?: string;
413
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
414
+ upload_protocol?: string;
415
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
416
+ uploadType?: string;
417
+ }): Request<ListReservationTopicsResponse>;
418
+ }
419
+ interface ReservationsResource {
420
+ /** Creates a new reservation. */
421
+ create(request: {
422
+ /** V1 error format. */
423
+ '$.xgafv'?: string;
424
+ /** OAuth access token. */
425
+ access_token?: string;
426
+ /** Data format for response. */
427
+ alt?: string;
428
+ /** JSONP */
429
+ callback?: string;
430
+ /** Selector specifying which fields to include in a partial response. */
431
+ fields?: string;
432
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
433
+ key?: string;
434
+ /** OAuth 2.0 token for the current user. */
435
+ oauth_token?: string;
436
+ /** Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. */
437
+ parent: string;
438
+ /** Returns response with indentations and line breaks. */
439
+ prettyPrint?: boolean;
440
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
441
+ quotaUser?: string;
442
+ /** Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`. */
443
+ reservationId?: string;
444
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
445
+ upload_protocol?: string;
446
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
447
+ uploadType?: string;
448
+ /** Request body */
449
+ resource: Reservation;
450
+ }): Request<Reservation>;
451
+ create(
452
+ request: {
453
+ /** V1 error format. */
454
+ '$.xgafv'?: string;
455
+ /** OAuth access token. */
456
+ access_token?: string;
457
+ /** Data format for response. */
458
+ alt?: string;
459
+ /** JSONP */
460
+ callback?: string;
461
+ /** Selector specifying which fields to include in a partial response. */
462
+ fields?: string;
463
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
464
+ key?: string;
465
+ /** OAuth 2.0 token for the current user. */
466
+ oauth_token?: string;
467
+ /** Required. The parent location in which to create the reservation. Structured like `projects/{project_number}/locations/{location}`. */
468
+ parent: string;
469
+ /** Returns response with indentations and line breaks. */
470
+ prettyPrint?: boolean;
471
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
472
+ quotaUser?: string;
473
+ /** Required. The ID to use for the reservation, which will become the final component of the reservation's name. This value is structured like: `my-reservation-name`. */
474
+ reservationId?: string;
475
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
476
+ upload_protocol?: string;
477
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
478
+ uploadType?: string;
479
+ },
480
+ body: Reservation
481
+ ): Request<Reservation>;
482
+ /** Deletes the specified reservation. */
483
+ delete(request?: {
484
+ /** V1 error format. */
485
+ '$.xgafv'?: string;
486
+ /** OAuth access token. */
487
+ access_token?: string;
488
+ /** Data format for response. */
489
+ alt?: string;
490
+ /** JSONP */
491
+ callback?: string;
492
+ /** Selector specifying which fields to include in a partial response. */
493
+ fields?: string;
494
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
495
+ key?: string;
496
+ /** Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
497
+ name: string;
498
+ /** OAuth 2.0 token for the current user. */
499
+ oauth_token?: string;
500
+ /** Returns response with indentations and line breaks. */
501
+ prettyPrint?: boolean;
502
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
503
+ quotaUser?: string;
504
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
505
+ upload_protocol?: string;
506
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
507
+ uploadType?: string;
508
+ }): Request<{}>;
509
+ /** Returns the reservation configuration. */
510
+ get(request?: {
511
+ /** V1 error format. */
512
+ '$.xgafv'?: string;
513
+ /** OAuth access token. */
514
+ access_token?: string;
515
+ /** Data format for response. */
516
+ alt?: string;
517
+ /** JSONP */
518
+ callback?: string;
519
+ /** Selector specifying which fields to include in a partial response. */
520
+ fields?: string;
521
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
522
+ key?: string;
523
+ /** Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
524
+ name: string;
525
+ /** OAuth 2.0 token for the current user. */
526
+ oauth_token?: string;
527
+ /** Returns response with indentations and line breaks. */
528
+ prettyPrint?: boolean;
529
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
530
+ quotaUser?: string;
531
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
532
+ upload_protocol?: string;
533
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
534
+ uploadType?: string;
535
+ }): Request<Reservation>;
536
+ /** Returns the list of reservations for the given project. */
537
+ list(request?: {
538
+ /** V1 error format. */
539
+ '$.xgafv'?: string;
540
+ /** OAuth access token. */
541
+ access_token?: string;
542
+ /** Data format for response. */
543
+ alt?: string;
544
+ /** JSONP */
545
+ callback?: string;
546
+ /** Selector specifying which fields to include in a partial response. */
547
+ fields?: string;
548
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
549
+ key?: string;
550
+ /** OAuth 2.0 token for the current user. */
551
+ oauth_token?: string;
552
+ /** The maximum number of reservations to return. The service may return fewer than this value. If unset or zero, all reservations for the parent will be returned. */
553
+ pageSize?: number;
554
+ /** A page token, received from a previous `ListReservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReservations` must match the call that provided the page token. */
555
+ pageToken?: string;
556
+ /** Required. The parent whose reservations are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
557
+ parent: string;
558
+ /** Returns response with indentations and line breaks. */
559
+ prettyPrint?: boolean;
560
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
561
+ quotaUser?: string;
562
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
563
+ upload_protocol?: string;
564
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
565
+ uploadType?: string;
566
+ }): Request<ListReservationsResponse>;
567
+ /** Updates properties of the specified reservation. */
568
+ patch(request: {
569
+ /** V1 error format. */
570
+ '$.xgafv'?: string;
571
+ /** OAuth access token. */
572
+ access_token?: string;
573
+ /** Data format for response. */
574
+ alt?: string;
575
+ /** JSONP */
576
+ callback?: string;
577
+ /** Selector specifying which fields to include in a partial response. */
578
+ fields?: string;
579
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
580
+ key?: string;
581
+ /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
582
+ name: string;
583
+ /** OAuth 2.0 token for the current user. */
584
+ oauth_token?: string;
585
+ /** Returns response with indentations and line breaks. */
586
+ prettyPrint?: boolean;
587
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
588
+ quotaUser?: string;
589
+ /** Required. A mask specifying the reservation fields to change. */
590
+ updateMask?: string;
591
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
592
+ upload_protocol?: string;
593
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
594
+ uploadType?: string;
595
+ /** Request body */
596
+ resource: Reservation;
597
+ }): Request<Reservation>;
598
+ patch(
599
+ request: {
600
+ /** V1 error format. */
601
+ '$.xgafv'?: string;
602
+ /** OAuth access token. */
603
+ access_token?: string;
604
+ /** Data format for response. */
605
+ alt?: string;
606
+ /** JSONP */
607
+ callback?: string;
608
+ /** Selector specifying which fields to include in a partial response. */
609
+ fields?: string;
610
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
611
+ key?: string;
612
+ /** The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id} */
613
+ name: string;
614
+ /** OAuth 2.0 token for the current user. */
615
+ oauth_token?: string;
616
+ /** Returns response with indentations and line breaks. */
617
+ prettyPrint?: boolean;
618
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
619
+ quotaUser?: string;
620
+ /** Required. A mask specifying the reservation fields to change. */
621
+ updateMask?: string;
622
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
623
+ upload_protocol?: string;
624
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
625
+ uploadType?: string;
626
+ },
627
+ body: Reservation
628
+ ): Request<Reservation>;
629
+ topics: TopicsResource;
630
+ }
631
+ interface SubscriptionsResource {
632
+ /** Creates a new subscription. */
633
+ create(request: {
634
+ /** V1 error format. */
635
+ '$.xgafv'?: string;
636
+ /** OAuth access token. */
637
+ access_token?: string;
638
+ /** Data format for response. */
639
+ alt?: string;
640
+ /** JSONP */
641
+ callback?: string;
642
+ /** Selector specifying which fields to include in a partial response. */
643
+ fields?: string;
644
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
645
+ key?: string;
646
+ /** OAuth 2.0 token for the current user. */
647
+ oauth_token?: string;
648
+ /** Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. */
649
+ parent: string;
650
+ /** Returns response with indentations and line breaks. */
651
+ prettyPrint?: boolean;
652
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
653
+ quotaUser?: string;
654
+ /** If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false. */
655
+ skipBacklog?: boolean;
656
+ /** Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`. */
657
+ subscriptionId?: string;
658
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
659
+ upload_protocol?: string;
660
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
661
+ uploadType?: string;
662
+ /** Request body */
663
+ resource: Subscription;
664
+ }): Request<Subscription>;
665
+ create(
666
+ request: {
667
+ /** V1 error format. */
668
+ '$.xgafv'?: string;
669
+ /** OAuth access token. */
670
+ access_token?: string;
671
+ /** Data format for response. */
672
+ alt?: string;
673
+ /** JSONP */
674
+ callback?: string;
675
+ /** Selector specifying which fields to include in a partial response. */
676
+ fields?: string;
677
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
678
+ key?: string;
679
+ /** OAuth 2.0 token for the current user. */
680
+ oauth_token?: string;
681
+ /** Required. The parent location in which to create the subscription. Structured like `projects/{project_number}/locations/{location}`. */
682
+ parent: string;
683
+ /** Returns response with indentations and line breaks. */
684
+ prettyPrint?: boolean;
685
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
686
+ quotaUser?: string;
687
+ /** If true, the newly created subscription will only receive messages published after the subscription was created. Otherwise, the entire message backlog will be received on the subscription. Defaults to false. */
688
+ skipBacklog?: boolean;
689
+ /** Required. The ID to use for the subscription, which will become the final component of the subscription's name. This value is structured like: `my-sub-name`. */
690
+ subscriptionId?: string;
691
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
692
+ upload_protocol?: string;
693
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
694
+ uploadType?: string;
695
+ },
696
+ body: Subscription
697
+ ): Request<Subscription>;
698
+ /** Deletes the specified subscription. */
699
+ delete(request?: {
700
+ /** V1 error format. */
701
+ '$.xgafv'?: string;
702
+ /** OAuth access token. */
703
+ access_token?: string;
704
+ /** Data format for response. */
705
+ alt?: string;
706
+ /** JSONP */
707
+ callback?: string;
708
+ /** Selector specifying which fields to include in a partial response. */
709
+ fields?: string;
710
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
711
+ key?: string;
712
+ /** Required. The name of the subscription to delete. */
713
+ name: string;
714
+ /** OAuth 2.0 token for the current user. */
715
+ oauth_token?: string;
716
+ /** Returns response with indentations and line breaks. */
717
+ prettyPrint?: boolean;
718
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
719
+ quotaUser?: string;
720
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
721
+ upload_protocol?: string;
722
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
723
+ uploadType?: string;
724
+ }): Request<{}>;
725
+ /** Returns the subscription configuration. */
726
+ get(request?: {
727
+ /** V1 error format. */
728
+ '$.xgafv'?: string;
729
+ /** OAuth access token. */
730
+ access_token?: string;
731
+ /** Data format for response. */
732
+ alt?: string;
733
+ /** JSONP */
734
+ callback?: string;
735
+ /** Selector specifying which fields to include in a partial response. */
736
+ fields?: string;
737
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
738
+ key?: string;
739
+ /** Required. The name of the subscription whose configuration to return. */
740
+ name: string;
741
+ /** OAuth 2.0 token for the current user. */
742
+ oauth_token?: string;
743
+ /** Returns response with indentations and line breaks. */
744
+ prettyPrint?: boolean;
745
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
746
+ quotaUser?: string;
747
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
748
+ upload_protocol?: string;
749
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
750
+ uploadType?: string;
751
+ }): Request<Subscription>;
752
+ /** Returns the list of subscriptions for the given project. */
753
+ list(request?: {
754
+ /** V1 error format. */
755
+ '$.xgafv'?: string;
756
+ /** OAuth access token. */
757
+ access_token?: string;
758
+ /** Data format for response. */
759
+ alt?: string;
760
+ /** JSONP */
761
+ callback?: string;
762
+ /** Selector specifying which fields to include in a partial response. */
763
+ fields?: string;
764
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
765
+ key?: string;
766
+ /** OAuth 2.0 token for the current user. */
767
+ oauth_token?: string;
768
+ /** The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the parent will be returned. */
769
+ pageSize?: number;
770
+ /** A page token, received from a previous `ListSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscriptions` must match the call that provided the page token. */
771
+ pageToken?: string;
772
+ /** Required. The parent whose subscriptions are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
773
+ parent: string;
774
+ /** Returns response with indentations and line breaks. */
775
+ prettyPrint?: boolean;
776
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
777
+ quotaUser?: string;
778
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
779
+ upload_protocol?: string;
780
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
781
+ uploadType?: string;
782
+ }): Request<ListSubscriptionsResponse>;
783
+ /** Updates properties of the specified subscription. */
784
+ patch(request: {
785
+ /** V1 error format. */
786
+ '$.xgafv'?: string;
787
+ /** OAuth access token. */
788
+ access_token?: string;
789
+ /** Data format for response. */
790
+ alt?: string;
791
+ /** JSONP */
792
+ callback?: string;
793
+ /** Selector specifying which fields to include in a partial response. */
794
+ fields?: string;
795
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
796
+ key?: string;
797
+ /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
798
+ name: string;
799
+ /** OAuth 2.0 token for the current user. */
800
+ oauth_token?: string;
801
+ /** Returns response with indentations and line breaks. */
802
+ prettyPrint?: boolean;
803
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
804
+ quotaUser?: string;
805
+ /** Required. A mask specifying the subscription fields to change. */
806
+ updateMask?: string;
807
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
808
+ upload_protocol?: string;
809
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
810
+ uploadType?: string;
811
+ /** Request body */
812
+ resource: Subscription;
813
+ }): Request<Subscription>;
814
+ patch(
815
+ request: {
816
+ /** V1 error format. */
817
+ '$.xgafv'?: string;
818
+ /** OAuth access token. */
819
+ access_token?: string;
820
+ /** Data format for response. */
821
+ alt?: string;
822
+ /** JSONP */
823
+ callback?: string;
824
+ /** Selector specifying which fields to include in a partial response. */
825
+ fields?: string;
826
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
827
+ key?: string;
828
+ /** The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} */
829
+ name: string;
830
+ /** OAuth 2.0 token for the current user. */
831
+ oauth_token?: string;
832
+ /** Returns response with indentations and line breaks. */
833
+ prettyPrint?: boolean;
834
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
835
+ quotaUser?: string;
836
+ /** Required. A mask specifying the subscription fields to change. */
837
+ updateMask?: string;
838
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
839
+ upload_protocol?: string;
840
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
841
+ uploadType?: string;
842
+ },
843
+ body: Subscription
844
+ ): Request<Subscription>;
845
+ /** Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it. */
846
+ seek(request: {
847
+ /** V1 error format. */
848
+ '$.xgafv'?: string;
849
+ /** OAuth access token. */
850
+ access_token?: string;
851
+ /** Data format for response. */
852
+ alt?: string;
853
+ /** JSONP */
854
+ callback?: string;
855
+ /** Selector specifying which fields to include in a partial response. */
856
+ fields?: string;
857
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
858
+ key?: string;
859
+ /** Required. The name of the subscription to seek. */
860
+ name: string;
861
+ /** OAuth 2.0 token for the current user. */
862
+ oauth_token?: string;
863
+ /** Returns response with indentations and line breaks. */
864
+ prettyPrint?: boolean;
865
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
866
+ quotaUser?: string;
867
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
868
+ upload_protocol?: string;
869
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
870
+ uploadType?: string;
871
+ /** Request body */
872
+ resource: SeekSubscriptionRequest;
873
+ }): Request<Operation>;
874
+ seek(
875
+ request: {
876
+ /** V1 error format. */
877
+ '$.xgafv'?: string;
878
+ /** OAuth access token. */
879
+ access_token?: string;
880
+ /** Data format for response. */
881
+ alt?: string;
882
+ /** JSONP */
883
+ callback?: string;
884
+ /** Selector specifying which fields to include in a partial response. */
885
+ fields?: string;
886
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
887
+ key?: string;
888
+ /** Required. The name of the subscription to seek. */
889
+ name: string;
890
+ /** OAuth 2.0 token for the current user. */
891
+ oauth_token?: string;
892
+ /** Returns response with indentations and line breaks. */
893
+ prettyPrint?: boolean;
894
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
895
+ quotaUser?: string;
896
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
897
+ upload_protocol?: string;
898
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
899
+ uploadType?: string;
900
+ },
901
+ body: SeekSubscriptionRequest
902
+ ): Request<Operation>;
903
+ }
904
+ interface SubscriptionsResource {
905
+ /** Lists the subscriptions attached to the specified topic. */
906
+ list(request?: {
907
+ /** V1 error format. */
908
+ '$.xgafv'?: string;
909
+ /** OAuth access token. */
910
+ access_token?: string;
911
+ /** Data format for response. */
912
+ alt?: string;
913
+ /** JSONP */
914
+ callback?: string;
915
+ /** Selector specifying which fields to include in a partial response. */
916
+ fields?: string;
917
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
918
+ key?: string;
919
+ /** Required. The name of the topic whose subscriptions to list. */
920
+ name: string;
921
+ /** OAuth 2.0 token for the current user. */
922
+ oauth_token?: string;
923
+ /** The maximum number of subscriptions to return. The service may return fewer than this value. If unset or zero, all subscriptions for the given topic will be returned. */
924
+ pageSize?: number;
925
+ /** A page token, received from a previous `ListTopicSubscriptions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopicSubscriptions` must match the call that provided the page token. */
926
+ pageToken?: string;
927
+ /** Returns response with indentations and line breaks. */
928
+ prettyPrint?: boolean;
929
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
930
+ quotaUser?: string;
931
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
932
+ upload_protocol?: string;
933
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
934
+ uploadType?: string;
935
+ }): Request<ListTopicSubscriptionsResponse>;
936
+ }
937
+ interface TopicsResource {
938
+ /** Creates a new topic. */
939
+ create(request: {
940
+ /** V1 error format. */
941
+ '$.xgafv'?: string;
942
+ /** OAuth access token. */
943
+ access_token?: string;
944
+ /** Data format for response. */
945
+ alt?: string;
946
+ /** JSONP */
947
+ callback?: string;
948
+ /** Selector specifying which fields to include in a partial response. */
949
+ fields?: string;
950
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
951
+ key?: string;
952
+ /** OAuth 2.0 token for the current user. */
953
+ oauth_token?: string;
954
+ /** Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. */
955
+ parent: string;
956
+ /** Returns response with indentations and line breaks. */
957
+ prettyPrint?: boolean;
958
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
959
+ quotaUser?: string;
960
+ /** Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. */
961
+ topicId?: string;
962
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
963
+ upload_protocol?: string;
964
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
965
+ uploadType?: string;
966
+ /** Request body */
967
+ resource: Topic;
968
+ }): Request<Topic>;
969
+ create(
970
+ request: {
971
+ /** V1 error format. */
972
+ '$.xgafv'?: string;
973
+ /** OAuth access token. */
974
+ access_token?: string;
975
+ /** Data format for response. */
976
+ alt?: string;
977
+ /** JSONP */
978
+ callback?: string;
979
+ /** Selector specifying which fields to include in a partial response. */
980
+ fields?: string;
981
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
982
+ key?: string;
983
+ /** OAuth 2.0 token for the current user. */
984
+ oauth_token?: string;
985
+ /** Required. The parent location in which to create the topic. Structured like `projects/{project_number}/locations/{location}`. */
986
+ parent: string;
987
+ /** Returns response with indentations and line breaks. */
988
+ prettyPrint?: boolean;
989
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
990
+ quotaUser?: string;
991
+ /** Required. The ID to use for the topic, which will become the final component of the topic's name. This value is structured like: `my-topic-name`. */
992
+ topicId?: string;
993
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
994
+ upload_protocol?: string;
995
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
996
+ uploadType?: string;
997
+ },
998
+ body: Topic
999
+ ): Request<Topic>;
1000
+ /** Deletes the specified topic. */
1001
+ delete(request?: {
1002
+ /** V1 error format. */
1003
+ '$.xgafv'?: string;
1004
+ /** OAuth access token. */
1005
+ access_token?: string;
1006
+ /** Data format for response. */
1007
+ alt?: string;
1008
+ /** JSONP */
1009
+ callback?: string;
1010
+ /** Selector specifying which fields to include in a partial response. */
1011
+ fields?: string;
1012
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1013
+ key?: string;
1014
+ /** Required. The name of the topic to delete. */
1015
+ name: string;
1016
+ /** OAuth 2.0 token for the current user. */
1017
+ oauth_token?: string;
1018
+ /** Returns response with indentations and line breaks. */
1019
+ prettyPrint?: boolean;
1020
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1021
+ quotaUser?: string;
1022
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1023
+ upload_protocol?: string;
1024
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1025
+ uploadType?: string;
1026
+ }): Request<{}>;
1027
+ /** Returns the topic configuration. */
1028
+ get(request?: {
1029
+ /** V1 error format. */
1030
+ '$.xgafv'?: string;
1031
+ /** OAuth access token. */
1032
+ access_token?: string;
1033
+ /** Data format for response. */
1034
+ alt?: string;
1035
+ /** JSONP */
1036
+ callback?: string;
1037
+ /** Selector specifying which fields to include in a partial response. */
1038
+ fields?: string;
1039
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1040
+ key?: string;
1041
+ /** Required. The name of the topic whose configuration to return. */
1042
+ name: string;
1043
+ /** OAuth 2.0 token for the current user. */
1044
+ oauth_token?: string;
1045
+ /** Returns response with indentations and line breaks. */
1046
+ prettyPrint?: boolean;
1047
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1048
+ quotaUser?: string;
1049
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1050
+ upload_protocol?: string;
1051
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1052
+ uploadType?: string;
1053
+ }): Request<Topic>;
1054
+ /** Returns the partition information for the requested topic. */
1055
+ getPartitions(request?: {
1056
+ /** V1 error format. */
1057
+ '$.xgafv'?: string;
1058
+ /** OAuth access token. */
1059
+ access_token?: string;
1060
+ /** Data format for response. */
1061
+ alt?: string;
1062
+ /** JSONP */
1063
+ callback?: string;
1064
+ /** Selector specifying which fields to include in a partial response. */
1065
+ fields?: string;
1066
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1067
+ key?: string;
1068
+ /** Required. The topic whose partition information to return. */
1069
+ name: string;
1070
+ /** OAuth 2.0 token for the current user. */
1071
+ oauth_token?: string;
1072
+ /** Returns response with indentations and line breaks. */
1073
+ prettyPrint?: boolean;
1074
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1075
+ quotaUser?: string;
1076
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1077
+ upload_protocol?: string;
1078
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1079
+ uploadType?: string;
1080
+ }): Request<TopicPartitions>;
1081
+ /** Returns the list of topics for the given project. */
1082
+ list(request?: {
1083
+ /** V1 error format. */
1084
+ '$.xgafv'?: string;
1085
+ /** OAuth access token. */
1086
+ access_token?: string;
1087
+ /** Data format for response. */
1088
+ alt?: string;
1089
+ /** JSONP */
1090
+ callback?: string;
1091
+ /** Selector specifying which fields to include in a partial response. */
1092
+ fields?: string;
1093
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1094
+ key?: string;
1095
+ /** OAuth 2.0 token for the current user. */
1096
+ oauth_token?: string;
1097
+ /** The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent will be returned. */
1098
+ pageSize?: number;
1099
+ /** A page token, received from a previous `ListTopics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTopics` must match the call that provided the page token. */
1100
+ pageToken?: string;
1101
+ /** Required. The parent whose topics are to be listed. Structured like `projects/{project_number}/locations/{location}`. */
1102
+ parent: string;
1103
+ /** Returns response with indentations and line breaks. */
1104
+ prettyPrint?: boolean;
1105
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1106
+ quotaUser?: string;
1107
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1108
+ upload_protocol?: string;
1109
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1110
+ uploadType?: string;
1111
+ }): Request<ListTopicsResponse>;
1112
+ /** Updates properties of the specified topic. */
1113
+ patch(request: {
1114
+ /** V1 error format. */
1115
+ '$.xgafv'?: string;
1116
+ /** OAuth access token. */
1117
+ access_token?: string;
1118
+ /** Data format for response. */
1119
+ alt?: string;
1120
+ /** JSONP */
1121
+ callback?: string;
1122
+ /** Selector specifying which fields to include in a partial response. */
1123
+ fields?: string;
1124
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1125
+ key?: string;
1126
+ /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
1127
+ name: string;
1128
+ /** OAuth 2.0 token for the current user. */
1129
+ oauth_token?: string;
1130
+ /** Returns response with indentations and line breaks. */
1131
+ prettyPrint?: boolean;
1132
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1133
+ quotaUser?: string;
1134
+ /** Required. A mask specifying the topic fields to change. */
1135
+ updateMask?: string;
1136
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1137
+ upload_protocol?: string;
1138
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1139
+ uploadType?: string;
1140
+ /** Request body */
1141
+ resource: Topic;
1142
+ }): Request<Topic>;
1143
+ patch(
1144
+ request: {
1145
+ /** V1 error format. */
1146
+ '$.xgafv'?: string;
1147
+ /** OAuth access token. */
1148
+ access_token?: string;
1149
+ /** Data format for response. */
1150
+ alt?: string;
1151
+ /** JSONP */
1152
+ callback?: string;
1153
+ /** Selector specifying which fields to include in a partial response. */
1154
+ fields?: string;
1155
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1156
+ key?: string;
1157
+ /** The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} */
1158
+ name: string;
1159
+ /** OAuth 2.0 token for the current user. */
1160
+ oauth_token?: string;
1161
+ /** Returns response with indentations and line breaks. */
1162
+ prettyPrint?: boolean;
1163
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1164
+ quotaUser?: string;
1165
+ /** Required. A mask specifying the topic fields to change. */
1166
+ updateMask?: string;
1167
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1168
+ upload_protocol?: string;
1169
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1170
+ uploadType?: string;
1171
+ },
1172
+ body: Topic
1173
+ ): Request<Topic>;
1174
+ subscriptions: SubscriptionsResource;
1175
+ }
1176
+ interface LocationsResource {
1177
+ operations: OperationsResource;
1178
+ reservations: ReservationsResource;
1179
+ subscriptions: SubscriptionsResource;
1180
+ topics: TopicsResource;
1181
+ }
1182
+ interface ProjectsResource {
1183
+ locations: LocationsResource;
1184
+ }
1185
+ interface AdminResource {
1186
+ projects: ProjectsResource;
1187
+ }
1188
+ interface CursorsResource {
1189
+ /** Returns all committed cursor information for a subscription. */
1190
+ list(request?: {
1191
+ /** V1 error format. */
1192
+ '$.xgafv'?: string;
1193
+ /** OAuth access token. */
1194
+ access_token?: string;
1195
+ /** Data format for response. */
1196
+ alt?: string;
1197
+ /** JSONP */
1198
+ callback?: string;
1199
+ /** Selector specifying which fields to include in a partial response. */
1200
+ fields?: string;
1201
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1202
+ key?: string;
1203
+ /** OAuth 2.0 token for the current user. */
1204
+ oauth_token?: string;
1205
+ /** The maximum number of cursors to return. The service may return fewer than this value. If unset or zero, all cursors for the parent will be returned. */
1206
+ pageSize?: number;
1207
+ /** A page token, received from a previous `ListPartitionCursors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPartitionCursors` must match the call that provided the page token. */
1208
+ pageToken?: string;
1209
+ /** Required. The subscription for which to retrieve cursors. Structured like `projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`. */
1210
+ parent: string;
1211
+ /** Returns response with indentations and line breaks. */
1212
+ prettyPrint?: boolean;
1213
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1214
+ quotaUser?: string;
1215
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1216
+ upload_protocol?: string;
1217
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1218
+ uploadType?: string;
1219
+ }): Request<ListPartitionCursorsResponse>;
1220
+ }
1221
+ interface SubscriptionsResource {
1222
+ /** Updates the committed cursor. */
1223
+ commitCursor(request: {
1224
+ /** V1 error format. */
1225
+ '$.xgafv'?: string;
1226
+ /** OAuth access token. */
1227
+ access_token?: string;
1228
+ /** Data format for response. */
1229
+ alt?: string;
1230
+ /** JSONP */
1231
+ callback?: string;
1232
+ /** Selector specifying which fields to include in a partial response. */
1233
+ fields?: string;
1234
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1235
+ key?: string;
1236
+ /** OAuth 2.0 token for the current user. */
1237
+ oauth_token?: string;
1238
+ /** Returns response with indentations and line breaks. */
1239
+ prettyPrint?: boolean;
1240
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1241
+ quotaUser?: string;
1242
+ /** The subscription for which to update the cursor. */
1243
+ subscription: string;
1244
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1245
+ upload_protocol?: string;
1246
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1247
+ uploadType?: string;
1248
+ /** Request body */
1249
+ resource: CommitCursorRequest;
1250
+ }): Request<{}>;
1251
+ commitCursor(
1252
+ request: {
1253
+ /** V1 error format. */
1254
+ '$.xgafv'?: string;
1255
+ /** OAuth access token. */
1256
+ access_token?: string;
1257
+ /** Data format for response. */
1258
+ alt?: string;
1259
+ /** JSONP */
1260
+ callback?: string;
1261
+ /** Selector specifying which fields to include in a partial response. */
1262
+ fields?: string;
1263
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1264
+ key?: string;
1265
+ /** OAuth 2.0 token for the current user. */
1266
+ oauth_token?: string;
1267
+ /** Returns response with indentations and line breaks. */
1268
+ prettyPrint?: boolean;
1269
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1270
+ quotaUser?: string;
1271
+ /** The subscription for which to update the cursor. */
1272
+ subscription: string;
1273
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1274
+ upload_protocol?: string;
1275
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1276
+ uploadType?: string;
1277
+ },
1278
+ body: CommitCursorRequest
1279
+ ): Request<{}>;
1280
+ cursors: CursorsResource;
1281
+ }
1282
+ interface LocationsResource {
1283
+ subscriptions: SubscriptionsResource;
1284
+ }
1285
+ interface ProjectsResource {
1286
+ locations: LocationsResource;
1287
+ }
1288
+ interface CursorResource {
1289
+ projects: ProjectsResource;
1290
+ }
1291
+ interface TopicsResource {
1292
+ /** Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition. */
1293
+ computeHeadCursor(request: {
1294
+ /** V1 error format. */
1295
+ '$.xgafv'?: string;
1296
+ /** OAuth access token. */
1297
+ access_token?: string;
1298
+ /** Data format for response. */
1299
+ alt?: string;
1300
+ /** JSONP */
1301
+ callback?: string;
1302
+ /** Selector specifying which fields to include in a partial response. */
1303
+ fields?: string;
1304
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1305
+ key?: string;
1306
+ /** OAuth 2.0 token for the current user. */
1307
+ oauth_token?: string;
1308
+ /** Returns response with indentations and line breaks. */
1309
+ prettyPrint?: boolean;
1310
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1311
+ quotaUser?: string;
1312
+ /** Required. The topic for which we should compute the head cursor. */
1313
+ topic: string;
1314
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1315
+ upload_protocol?: string;
1316
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1317
+ uploadType?: string;
1318
+ /** Request body */
1319
+ resource: ComputeHeadCursorRequest;
1320
+ }): Request<ComputeHeadCursorResponse>;
1321
+ computeHeadCursor(
1322
+ request: {
1323
+ /** V1 error format. */
1324
+ '$.xgafv'?: string;
1325
+ /** OAuth access token. */
1326
+ access_token?: string;
1327
+ /** Data format for response. */
1328
+ alt?: string;
1329
+ /** JSONP */
1330
+ callback?: string;
1331
+ /** Selector specifying which fields to include in a partial response. */
1332
+ fields?: string;
1333
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1334
+ key?: string;
1335
+ /** OAuth 2.0 token for the current user. */
1336
+ oauth_token?: string;
1337
+ /** Returns response with indentations and line breaks. */
1338
+ prettyPrint?: boolean;
1339
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1340
+ quotaUser?: string;
1341
+ /** Required. The topic for which we should compute the head cursor. */
1342
+ topic: string;
1343
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1344
+ upload_protocol?: string;
1345
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1346
+ uploadType?: string;
1347
+ },
1348
+ body: ComputeHeadCursorRequest
1349
+ ): Request<ComputeHeadCursorResponse>;
1350
+ /** Compute statistics about a range of messages in a given topic and partition. */
1351
+ computeMessageStats(request: {
1352
+ /** V1 error format. */
1353
+ '$.xgafv'?: string;
1354
+ /** OAuth access token. */
1355
+ access_token?: string;
1356
+ /** Data format for response. */
1357
+ alt?: string;
1358
+ /** JSONP */
1359
+ callback?: string;
1360
+ /** Selector specifying which fields to include in a partial response. */
1361
+ fields?: string;
1362
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1363
+ key?: string;
1364
+ /** OAuth 2.0 token for the current user. */
1365
+ oauth_token?: string;
1366
+ /** Returns response with indentations and line breaks. */
1367
+ prettyPrint?: boolean;
1368
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1369
+ quotaUser?: string;
1370
+ /** Required. The topic for which we should compute message stats. */
1371
+ topic: string;
1372
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1373
+ upload_protocol?: string;
1374
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1375
+ uploadType?: string;
1376
+ /** Request body */
1377
+ resource: ComputeMessageStatsRequest;
1378
+ }): Request<ComputeMessageStatsResponse>;
1379
+ computeMessageStats(
1380
+ request: {
1381
+ /** V1 error format. */
1382
+ '$.xgafv'?: string;
1383
+ /** OAuth access token. */
1384
+ access_token?: string;
1385
+ /** Data format for response. */
1386
+ alt?: string;
1387
+ /** JSONP */
1388
+ callback?: string;
1389
+ /** Selector specifying which fields to include in a partial response. */
1390
+ fields?: string;
1391
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1392
+ key?: string;
1393
+ /** OAuth 2.0 token for the current user. */
1394
+ oauth_token?: string;
1395
+ /** Returns response with indentations and line breaks. */
1396
+ prettyPrint?: boolean;
1397
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1398
+ quotaUser?: string;
1399
+ /** Required. The topic for which we should compute message stats. */
1400
+ topic: string;
1401
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1402
+ upload_protocol?: string;
1403
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1404
+ uploadType?: string;
1405
+ },
1406
+ body: ComputeMessageStatsRequest
1407
+ ): Request<ComputeMessageStatsResponse>;
1408
+ /** Compute the corresponding cursor for a publish or event time in a topic partition. */
1409
+ computeTimeCursor(request: {
1410
+ /** V1 error format. */
1411
+ '$.xgafv'?: string;
1412
+ /** OAuth access token. */
1413
+ access_token?: string;
1414
+ /** Data format for response. */
1415
+ alt?: string;
1416
+ /** JSONP */
1417
+ callback?: string;
1418
+ /** Selector specifying which fields to include in a partial response. */
1419
+ fields?: string;
1420
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1421
+ key?: string;
1422
+ /** OAuth 2.0 token for the current user. */
1423
+ oauth_token?: string;
1424
+ /** Returns response with indentations and line breaks. */
1425
+ prettyPrint?: boolean;
1426
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1427
+ quotaUser?: string;
1428
+ /** Required. The topic for which we should compute the cursor. */
1429
+ topic: string;
1430
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1431
+ upload_protocol?: string;
1432
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1433
+ uploadType?: string;
1434
+ /** Request body */
1435
+ resource: ComputeTimeCursorRequest;
1436
+ }): Request<ComputeTimeCursorResponse>;
1437
+ computeTimeCursor(
1438
+ request: {
1439
+ /** V1 error format. */
1440
+ '$.xgafv'?: string;
1441
+ /** OAuth access token. */
1442
+ access_token?: string;
1443
+ /** Data format for response. */
1444
+ alt?: string;
1445
+ /** JSONP */
1446
+ callback?: string;
1447
+ /** Selector specifying which fields to include in a partial response. */
1448
+ fields?: string;
1449
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1450
+ key?: string;
1451
+ /** OAuth 2.0 token for the current user. */
1452
+ oauth_token?: string;
1453
+ /** Returns response with indentations and line breaks. */
1454
+ prettyPrint?: boolean;
1455
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1456
+ quotaUser?: string;
1457
+ /** Required. The topic for which we should compute the cursor. */
1458
+ topic: string;
1459
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1460
+ upload_protocol?: string;
1461
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1462
+ uploadType?: string;
1463
+ },
1464
+ body: ComputeTimeCursorRequest
1465
+ ): Request<ComputeTimeCursorResponse>;
1466
+ }
1467
+ interface LocationsResource {
1468
+ topics: TopicsResource;
1469
+ }
1470
+ interface ProjectsResource {
1471
+ locations: LocationsResource;
1472
+ }
1473
+ interface TopicStatsResource {
1474
+ projects: ProjectsResource;
1475
+ }
2160
1476
 
2161
- const admin: AdminResource;
1477
+ const admin: AdminResource;
2162
1478
 
2163
- const cursor: CursorResource;
1479
+ const cursor: CursorResource;
2164
1480
 
2165
- const topicStats: TopicStatsResource;
2166
- }
1481
+ const topicStats: TopicStatsResource;
1482
+ }
2167
1483
  }