blob: 430778ec93a1980a92159c0a12dd72ad60266f50 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
|
type: com.google.api.codegen.ConfigProto
config_schema_version: 1.0.0
language_settings:
java:
package_name: com.google.cloud.pubsub.v1
interface_names:
google.pubsub.v1.Publisher: TopicAdmin
google.pubsub.v1.Subscriber: SubscriptionAdmin
release_level: GA
python:
package_name: google.cloud.pubsub_v1.gapic
release_level: GA
go:
package_name: cloud.google.com/go/pubsub/apiv1
domain_layer_location: cloud.google.com/go/pubsub
release_level: GA
csharp:
package_name: Google.Cloud.PubSub.V1
interface_names:
google.pubsub.v1.Publisher: PublisherServiceApi
google.pubsub.v1.Subscriber: SubscriberServiceApi
release_level: GA
ruby:
package_name: Google::Cloud::PubSub::V1
release_level: BETA
php:
package_name: Google\Cloud\PubSub\V1
release_level: GA
nodejs:
package_name: pubsub.v1
domain_layer_location: google-cloud
release_level: GA
fixed_resource_name_values:
- entity_name: deleted_topic
fixed_value: _deleted-topic_
collection_oneofs:
- oneof_name: topic_oneof
collection_names:
- topic
- deleted_topic
collections:
- name_pattern: projects/{project}
entity_name: project
language_overrides:
- language: csharp
common_resource_name: Google.Api.Gax.ResourceNames.ProjectName
- name_pattern: projects/{project}/snapshots/{snapshot}
entity_name: snapshot
language_overrides:
- language: java
entity_name: project_snapshot
- name_pattern: projects/{project}/subscriptions/{subscription}
entity_name: subscription
language_overrides:
- language: java
entity_name: project_subscription
- name_pattern: projects/{project}/topics/{topic}
entity_name: topic
language_overrides:
- language: java
entity_name: project_topic
interfaces:
- name: google.pubsub.v1.Subscriber
lang_doc:
java: To retrieve messages from a subscription, see the Subscriber class.
retry_codes_def:
- name: idempotent
retry_codes:
- UNKNOWN
- ABORTED
- UNAVAILABLE
- name: non_idempotent
retry_codes:
- UNAVAILABLE
- name: none
retry_codes: []
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000 # 60 seconds
initial_rpc_timeout_millis: 60000 # 60 seconds
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 60000 # 60 seconds
total_timeout_millis: 600000 # 10 minutes
- name: messaging
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000 # 60 seconds
initial_rpc_timeout_millis: 12000 # 12 seconds
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 12000 # 12 seconds
total_timeout_millis: 600000 # 10 minutes
- name: streaming_messaging
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000 # 60 seconds
initial_rpc_timeout_millis: 600000 # 10 minutes
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 600000 # 10 minutes
total_timeout_millis: 600000 # 10 minutes
methods:
- name: CreateSubscription
flattening:
groups:
- parameters:
- name
- topic
- push_config
- ack_deadline_seconds
required_fields:
- name
- topic
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
name: subscription
topic: topic
timeout_millis: 60000
- name: GetSubscription
flattening:
groups:
- parameters:
- subscription
required_fields:
- subscription
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
subscription: subscription
timeout_millis: 60000
- name: UpdateSubscription
required_fields:
- subscription
- update_mask
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- update_mask.paths[0]="ack_deadline_seconds"
- subscription.ack_deadline_seconds=42
- name: ListSubscriptions
flattening:
groups:
- parameters:
- project
required_fields:
- project
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: subscriptions
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
project: project
timeout_millis: 60000
- name: DeleteSubscription
flattening:
groups:
- parameters:
- subscription
required_fields:
- subscription
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
subscription: subscription
timeout_millis: 60000
- name: GetSnapshot
surface_treatments:
- include_languages:
- go
- java
- csharp
- ruby
- nodejs
- python
- php
visibility: DISABLED
- name: ModifyAckDeadline
flattening:
groups:
- parameters:
- subscription
- ack_ids
- ack_deadline_seconds
required_fields:
- subscription
- ack_ids
- ack_deadline_seconds
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
subscription: subscription
timeout_millis: 60000
surface_treatments:
- include_languages:
- java
visibility: PACKAGE
- name: Acknowledge
flattening:
groups:
- parameters:
- subscription
- ack_ids
required_fields:
- subscription
- ack_ids
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: messaging
field_name_patterns:
subscription: subscription
timeout_millis: 60000
surface_treatments:
- include_languages:
- java
visibility: PACKAGE
- name: Pull
flattening:
groups:
- parameters:
- subscription
- return_immediately
- max_messages
required_fields:
- subscription
- max_messages
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: messaging
field_name_patterns:
subscription: subscription
timeout_millis: 60000
surface_treatments:
- include_languages:
- java
visibility: PACKAGE
- name: StreamingPull
required_fields:
- subscription
- stream_ack_deadline_seconds
grpc_streaming:
response:
resources_field: received_messages
resource_name_treatment: STATIC_TYPES
retry_codes_name: none
retry_params_name: streaming_messaging
field_name_patterns:
subscription: subscription
timeout_millis: 900000
surface_treatments:
- include_languages:
- java
visibility: PACKAGE
- name: ModifyPushConfig
flattening:
groups:
- parameters:
- subscription
- push_config
required_fields:
- subscription
- push_config
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
subscription: subscription
timeout_millis: 60000
- name: ListSnapshots
flattening:
groups:
- parameters:
- project
required_fields:
- project
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: snapshots
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
project: project
timeout_millis: 60000
- name: CreateSnapshot
flattening:
groups:
- parameters:
- name
- subscription
required_fields:
- name
- subscription
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: snapshot
subscription: subscription
timeout_millis: 60000
- name: UpdateSnapshot
required_fields:
- snapshot
- update_mask
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
sample_code_init_fields:
- update_mask.paths[0]="expire_time"
- snapshot.expire_time.seconds=123456
- name: DeleteSnapshot
flattening:
groups:
- parameters:
- snapshot
required_fields:
- snapshot
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
snapshot: snapshot
timeout_millis: 60000
- name: Seek
# Not including flattening until oneof support.
# https://github.com/googleapis/toolkit/issues/1057
required_fields:
- subscription
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
subscription: subscription
timeout_millis: 60000
- name: SetIamPolicy
flattening:
groups:
- parameters:
- resource
- policy
required_fields:
- resource
- policy
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
resource: subscription
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
- name: GetIamPolicy
flattening:
groups:
- parameters:
- resource
required_fields:
- resource
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
resource: subscription
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
- name: TestIamPermissions
flattening:
groups:
- parameters:
- resource
- permissions
required_fields:
- resource
- permissions
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
resource: subscription
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
- name: google.pubsub.v1.Publisher
lang_doc:
java: To publish messages to a topic, see the Publisher class.
smoke_test:
method: ListTopics
init_fields:
- project%project=$PROJECT_ID
retry_codes_def:
- name: idempotent
retry_codes:
- UNKNOWN
- ABORTED
- UNAVAILABLE
- name: non_idempotent
retry_codes:
- UNAVAILABLE
- name: none
retry_codes: []
- name: publish
retry_codes:
- ABORTED
- CANCELLED
- INTERNAL
- RESOURCE_EXHAUSTED
- UNKNOWN
- UNAVAILABLE
- DEADLINE_EXCEEDED
retry_params_def:
- name: default
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000 # 60 seconds
initial_rpc_timeout_millis: 60000 # 60 seconds
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 60000 # 60 seconds
total_timeout_millis: 600000 # 10 minutes
- name: messaging
initial_retry_delay_millis: 100
retry_delay_multiplier: 1.3
max_retry_delay_millis: 60000 # 60 seconds
initial_rpc_timeout_millis: 12000 # 12 seconds
rpc_timeout_multiplier: 1
max_rpc_timeout_millis: 30000 # 30 seconds
total_timeout_millis: 600000 # 10 minutes
methods:
- name: CreateTopic
flattening:
groups:
- parameters:
- name
required_fields:
- name
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
name: topic
timeout_millis: 60000
- name: UpdateTopic
required_fields:
- topic
- update_mask
retry_codes_name: non_idempotent
retry_params_name: default
timeout_millis: 60000
- name: Publish
flattening:
groups:
- parameters:
- topic
- messages
required_fields:
- topic
- messages
resource_name_treatment: STATIC_TYPES
retry_codes_name: publish
retry_params_name: messaging
batching:
thresholds:
element_count_threshold: 10
element_count_limit: 1000 # TO BE REMOVED LATER
request_byte_threshold: 1024 # 1 Kb
request_byte_limit: 10485760 # TO BE REMOVED LATER
delay_threshold_millis: 10
batch_descriptor:
batched_field: messages
discriminator_fields:
- topic
subresponse_field: message_ids
field_name_patterns:
topic: topic
sample_code_init_fields:
- messages[0].data
timeout_millis: 60000
surface_treatments:
- include_languages:
- java
visibility: PACKAGE
- name: GetTopic
flattening:
groups:
- parameters:
- topic
required_fields:
- topic
resource_name_treatment: STATIC_TYPES
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
topic: topic
timeout_millis: 60000
- name: ListTopics
flattening:
groups:
- parameters:
- project
required_fields:
- project
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: topics
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
project: project
timeout_millis: 60000
- name: ListTopicSubscriptions
flattening:
groups:
- parameters:
- topic
required_fields:
- topic
resource_name_treatment: STATIC_TYPES
page_streaming:
request:
page_size_field: page_size
token_field: page_token
response:
token_field: next_page_token
resources_field: subscriptions
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
topic: topic
timeout_millis: 60000
- name: ListTopicSnapshots
surface_treatments:
- include_languages:
- go
- java
- csharp
- ruby
- nodejs
- python
- php
visibility: DISABLED
- name: DeleteTopic
flattening:
groups:
- parameters:
- topic
required_fields:
- topic
resource_name_treatment: STATIC_TYPES
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
topic: topic
timeout_millis: 60000
- name: SetIamPolicy
flattening:
groups:
- parameters:
- resource
- policy
required_fields:
- resource
- policy
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
resource: topic
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
- name: GetIamPolicy
flattening:
groups:
- parameters:
- resource
required_fields:
- resource
retry_codes_name: idempotent
retry_params_name: default
field_name_patterns:
resource: topic
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
- name: TestIamPermissions
flattening:
groups:
- parameters:
- resource
- permissions
required_fields:
- resource
- permissions
retry_codes_name: non_idempotent
retry_params_name: default
field_name_patterns:
resource: topic
timeout_millis: 60000
reroute_to_grpc_interface: google.iam.v1.IAMPolicy
surface_treatments:
- include_languages:
- go
visibility: DISABLED
resource_name_generation:
- message_name: Topic
field_entity_map:
name: topic
- message_name: GetTopicRequest
field_entity_map:
topic: topic
- message_name: PublishRequest
field_entity_map:
topic: topic
- message_name: ListTopicsRequest
field_entity_map:
project: project
- message_name: ListTopicSubscriptionsRequest
field_entity_map:
topic: topic
- message_name: ListTopicSubscriptionsResponse
field_entity_map:
subscriptions: subscription
- message_name: DeleteTopicRequest
field_entity_map:
topic: topic
- message_name: Subscription
field_entity_map:
name: subscription
topic: topic_oneof
- message_name: GetSubscriptionRequest
field_entity_map:
subscription: subscription
- message_name: ListSubscriptionsRequest
field_entity_map:
project: project
- message_name: DeleteSubscriptionRequest
field_entity_map:
subscription: subscription
- message_name: ModifyPushConfigRequest
field_entity_map:
subscription: subscription
- message_name: PullRequest
field_entity_map:
subscription: subscription
- message_name: ModifyAckDeadlineRequest
field_entity_map:
subscription: subscription
- message_name: AcknowledgeRequest
field_entity_map:
subscription: subscription
- message_name: StreamingPullRequest
field_entity_map:
subscription: subscription
- message_name: Snapshot
field_entity_map:
name: snapshot
topic: topic
- message_name: CreateSnapshotRequest
field_entity_map:
name: snapshot
subscription: subscription
- message_name: ListSnapshotsRequest
field_entity_map:
project: project
- message_name: DeleteSnapshotRequest
field_entity_map:
snapshot: snapshot
- message_name: SeekRequest
field_entity_map:
subscription: subscription
snapshot: snapshot
|
