-
Notifications
You must be signed in to change notification settings - Fork 196
/
pubsub.py
1352 lines (1128 loc) · 55.5 KB
/
pubsub.py
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
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto # type: ignore
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import field_mask_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
from google.pubsub_v1.types import schema as gp_schema
__protobuf__ = proto.module(
package="google.pubsub.v1",
manifest={
"MessageStoragePolicy",
"SchemaSettings",
"Topic",
"PubsubMessage",
"GetTopicRequest",
"UpdateTopicRequest",
"PublishRequest",
"PublishResponse",
"ListTopicsRequest",
"ListTopicsResponse",
"ListTopicSubscriptionsRequest",
"ListTopicSubscriptionsResponse",
"ListTopicSnapshotsRequest",
"ListTopicSnapshotsResponse",
"DeleteTopicRequest",
"DetachSubscriptionRequest",
"DetachSubscriptionResponse",
"Subscription",
"RetryPolicy",
"DeadLetterPolicy",
"ExpirationPolicy",
"PushConfig",
"ReceivedMessage",
"GetSubscriptionRequest",
"UpdateSubscriptionRequest",
"ListSubscriptionsRequest",
"ListSubscriptionsResponse",
"DeleteSubscriptionRequest",
"ModifyPushConfigRequest",
"PullRequest",
"PullResponse",
"ModifyAckDeadlineRequest",
"AcknowledgeRequest",
"StreamingPullRequest",
"StreamingPullResponse",
"CreateSnapshotRequest",
"UpdateSnapshotRequest",
"Snapshot",
"GetSnapshotRequest",
"ListSnapshotsRequest",
"ListSnapshotsResponse",
"DeleteSnapshotRequest",
"SeekRequest",
"SeekResponse",
},
)
class MessageStoragePolicy(proto.Message):
r"""A policy constraining the storage of messages published to
the topic.
Attributes:
allowed_persistence_regions (Sequence[str]):
A list of IDs of GCP regions where messages
that are published to the topic may be persisted
in storage. Messages published by publishers
running in non-allowed GCP regions (or running
outside of GCP altogether) will be routed for
storage in one of the allowed regions. An empty
list means that no regions are allowed, and is
not a valid configuration.
"""
allowed_persistence_regions = proto.RepeatedField(proto.STRING, number=1,)
class SchemaSettings(proto.Message):
r"""Settings for validating messages published against a schema.
Attributes:
schema (str):
Required. The name of the schema that messages published
should be validated against. Format is
``projects/{project}/schemas/{schema}``. The value of this
field will be ``_deleted-schema_`` if the schema has been
deleted.
encoding (google.pubsub_v1.types.Encoding):
The encoding of messages validated against ``schema``.
"""
schema = proto.Field(proto.STRING, number=1,)
encoding = proto.Field(proto.ENUM, number=2, enum=gp_schema.Encoding,)
class Topic(proto.Message):
r"""A topic resource.
Attributes:
name (str):
Required. The name of the topic. It must have the format
``"projects/{project}/topics/{topic}"``. ``{topic}`` must
start with a letter, and contain only letters
(``[A-Za-z]``), numbers (``[0-9]``), dashes (``-``),
underscores (``_``), periods (``.``), tildes (``~``), plus
(``+``) or percent signs (``%``). It must be between 3 and
255 characters in length, and it must not start with
``"goog"``.
labels (Sequence[google.pubsub_v1.types.Topic.LabelsEntry]):
See [Creating and managing labels]
(https://cloud.google.com/pubsub/docs/labels).
message_storage_policy (google.pubsub_v1.types.MessageStoragePolicy):
Policy constraining the set of Google Cloud
Platform regions where messages published to the
topic may be stored. If not present, then no
constraints are in effect.
kms_key_name (str):
The resource name of the Cloud KMS CryptoKey to be used to
protect access to messages published on this topic.
The expected format is
``projects/*/locations/*/keyRings/*/cryptoKeys/*``.
schema_settings (google.pubsub_v1.types.SchemaSettings):
Settings for validating messages published
against a schema.
satisfies_pzs (bool):
Reserved for future use. This field is set
only in responses from the server; it is ignored
if it is set in any requests.
message_retention_duration (google.protobuf.duration_pb2.Duration):
Indicates the minimum duration to retain a message after it
is published to the topic. If this field is set, messages
published to the topic in the last
``message_retention_duration`` are always available to
subscribers. For instance, it allows any attached
subscription to `seek to a
timestamp <https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time>`__
that is up to ``message_retention_duration`` in the past. If
this field is not set, message retention is controlled by
settings on individual subscriptions. Cannot be more than 7
days or less than 10 minutes.
"""
name = proto.Field(proto.STRING, number=1,)
labels = proto.MapField(proto.STRING, proto.STRING, number=2,)
message_storage_policy = proto.Field(
proto.MESSAGE, number=3, message="MessageStoragePolicy",
)
kms_key_name = proto.Field(proto.STRING, number=5,)
schema_settings = proto.Field(proto.MESSAGE, number=6, message="SchemaSettings",)
satisfies_pzs = proto.Field(proto.BOOL, number=7,)
message_retention_duration = proto.Field(
proto.MESSAGE, number=8, message=duration_pb2.Duration,
)
class PubsubMessage(proto.Message):
r"""A message that is published by publishers and consumed by
subscribers. The message must contain either a non-empty data field
or at least one attribute. Note that client libraries represent this
object differently depending on the language. See the corresponding
`client library
documentation <https://cloud.google.com/pubsub/docs/reference/libraries>`__
for more information. See [quotas and limits]
(https://cloud.google.com/pubsub/quotas) for more information about
message limits.
Attributes:
data (bytes):
The message data field. If this field is
empty, the message must contain at least one
attribute.
attributes (Sequence[google.pubsub_v1.types.PubsubMessage.AttributesEntry]):
Attributes for this message. If this field is
empty, the message must contain non-empty data.
This can be used to filter messages on the
subscription.
message_id (str):
ID of this message, assigned by the server when the message
is published. Guaranteed to be unique within the topic. This
value may be read by a subscriber that receives a
``PubsubMessage`` via a ``Pull`` call or a push delivery. It
must not be populated by the publisher in a ``Publish``
call.
publish_time (google.protobuf.timestamp_pb2.Timestamp):
The time at which the message was published, populated by
the server when it receives the ``Publish`` call. It must
not be populated by the publisher in a ``Publish`` call.
ordering_key (str):
If non-empty, identifies related messages for which publish
order should be respected. If a ``Subscription`` has
``enable_message_ordering`` set to ``true``, messages
published with the same non-empty ``ordering_key`` value
will be delivered to subscribers in the order in which they
are received by the Pub/Sub system. All ``PubsubMessage``\ s
published in a given ``PublishRequest`` must specify the
same ``ordering_key`` value.
"""
data = proto.Field(proto.BYTES, number=1,)
attributes = proto.MapField(proto.STRING, proto.STRING, number=2,)
message_id = proto.Field(proto.STRING, number=3,)
publish_time = proto.Field(
proto.MESSAGE, number=4, message=timestamp_pb2.Timestamp,
)
ordering_key = proto.Field(proto.STRING, number=5,)
class GetTopicRequest(proto.Message):
r"""Request for the GetTopic method.
Attributes:
topic (str):
Required. The name of the topic to get. Format is
``projects/{project}/topics/{topic}``.
"""
topic = proto.Field(proto.STRING, number=1,)
class UpdateTopicRequest(proto.Message):
r"""Request for the UpdateTopic method.
Attributes:
topic (google.pubsub_v1.types.Topic):
Required. The updated topic object.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Required. Indicates which fields in the provided topic to
update. Must be specified and non-empty. Note that if
``update_mask`` contains "message_storage_policy" but the
``message_storage_policy`` is not set in the ``topic``
provided above, then the updated value is determined by the
policy configured at the project or organization level.
"""
topic = proto.Field(proto.MESSAGE, number=1, message="Topic",)
update_mask = proto.Field(
proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,
)
class PublishRequest(proto.Message):
r"""Request for the Publish method.
Attributes:
topic (str):
Required. The messages in the request will be published on
this topic. Format is ``projects/{project}/topics/{topic}``.
messages (Sequence[google.pubsub_v1.types.PubsubMessage]):
Required. The messages to publish.
"""
topic = proto.Field(proto.STRING, number=1,)
messages = proto.RepeatedField(proto.MESSAGE, number=2, message="PubsubMessage",)
class PublishResponse(proto.Message):
r"""Response for the ``Publish`` method.
Attributes:
message_ids (Sequence[str]):
The server-assigned ID of each published
message, in the same order as the messages in
the request. IDs are guaranteed to be unique
within the topic.
"""
message_ids = proto.RepeatedField(proto.STRING, number=1,)
class ListTopicsRequest(proto.Message):
r"""Request for the ``ListTopics`` method.
Attributes:
project (str):
Required. The name of the project in which to list topics.
Format is ``projects/{project-id}``.
page_size (int):
Maximum number of topics to return.
page_token (str):
The value returned by the last ``ListTopicsResponse``;
indicates that this is a continuation of a prior
``ListTopics`` call, and that the system should return the
next page of data.
"""
project = proto.Field(proto.STRING, number=1,)
page_size = proto.Field(proto.INT32, number=2,)
page_token = proto.Field(proto.STRING, number=3,)
class ListTopicsResponse(proto.Message):
r"""Response for the ``ListTopics`` method.
Attributes:
topics (Sequence[google.pubsub_v1.types.Topic]):
The resulting topics.
next_page_token (str):
If not empty, indicates that there may be more topics that
match the request; this value should be passed in a new
``ListTopicsRequest``.
"""
@property
def raw_page(self):
return self
topics = proto.RepeatedField(proto.MESSAGE, number=1, message="Topic",)
next_page_token = proto.Field(proto.STRING, number=2,)
class ListTopicSubscriptionsRequest(proto.Message):
r"""Request for the ``ListTopicSubscriptions`` method.
Attributes:
topic (str):
Required. The name of the topic that subscriptions are
attached to. Format is
``projects/{project}/topics/{topic}``.
page_size (int):
Maximum number of subscription names to
return.
page_token (str):
The value returned by the last
``ListTopicSubscriptionsResponse``; indicates that this is a
continuation of a prior ``ListTopicSubscriptions`` call, and
that the system should return the next page of data.
"""
topic = proto.Field(proto.STRING, number=1,)
page_size = proto.Field(proto.INT32, number=2,)
page_token = proto.Field(proto.STRING, number=3,)
class ListTopicSubscriptionsResponse(proto.Message):
r"""Response for the ``ListTopicSubscriptions`` method.
Attributes:
subscriptions (Sequence[str]):
The names of subscriptions attached to the
topic specified in the request.
next_page_token (str):
If not empty, indicates that there may be more subscriptions
that match the request; this value should be passed in a new
``ListTopicSubscriptionsRequest`` to get more subscriptions.
"""
@property
def raw_page(self):
return self
subscriptions = proto.RepeatedField(proto.STRING, number=1,)
next_page_token = proto.Field(proto.STRING, number=2,)
class ListTopicSnapshotsRequest(proto.Message):
r"""Request for the ``ListTopicSnapshots`` method.
Attributes:
topic (str):
Required. The name of the topic that snapshots are attached
to. Format is ``projects/{project}/topics/{topic}``.
page_size (int):
Maximum number of snapshot names to return.
page_token (str):
The value returned by the last
``ListTopicSnapshotsResponse``; indicates that this is a
continuation of a prior ``ListTopicSnapshots`` call, and
that the system should return the next page of data.
"""
topic = proto.Field(proto.STRING, number=1,)
page_size = proto.Field(proto.INT32, number=2,)
page_token = proto.Field(proto.STRING, number=3,)
class ListTopicSnapshotsResponse(proto.Message):
r"""Response for the ``ListTopicSnapshots`` method.
Attributes:
snapshots (Sequence[str]):
The names of the snapshots that match the
request.
next_page_token (str):
If not empty, indicates that there may be more snapshots
that match the request; this value should be passed in a new
``ListTopicSnapshotsRequest`` to get more snapshots.
"""
@property
def raw_page(self):
return self
snapshots = proto.RepeatedField(proto.STRING, number=1,)
next_page_token = proto.Field(proto.STRING, number=2,)
class DeleteTopicRequest(proto.Message):
r"""Request for the ``DeleteTopic`` method.
Attributes:
topic (str):
Required. Name of the topic to delete. Format is
``projects/{project}/topics/{topic}``.
"""
topic = proto.Field(proto.STRING, number=1,)
class DetachSubscriptionRequest(proto.Message):
r"""Request for the DetachSubscription method.
Attributes:
subscription (str):
Required. The subscription to detach. Format is
``projects/{project}/subscriptions/{subscription}``.
"""
subscription = proto.Field(proto.STRING, number=1,)
class DetachSubscriptionResponse(proto.Message):
r"""Response for the DetachSubscription method.
Reserved for future use.
"""
class Subscription(proto.Message):
r"""A subscription resource.
Attributes:
name (str):
Required. The name of the subscription. It must have the
format
``"projects/{project}/subscriptions/{subscription}"``.
``{subscription}`` must start with a letter, and contain
only letters (``[A-Za-z]``), numbers (``[0-9]``), dashes
(``-``), underscores (``_``), periods (``.``), tildes
(``~``), plus (``+``) or percent signs (``%``). It must be
between 3 and 255 characters in length, and it must not
start with ``"goog"``.
topic (str):
Required. The name of the topic from which this subscription
is receiving messages. Format is
``projects/{project}/topics/{topic}``. The value of this
field will be ``_deleted-topic_`` if the topic has been
deleted.
push_config (google.pubsub_v1.types.PushConfig):
If push delivery is used with this subscription, this field
is used to configure it. An empty ``pushConfig`` signifies
that the subscriber will pull and ack messages using API
methods.
ack_deadline_seconds (int):
The approximate amount of time (on a best-effort basis)
Pub/Sub waits for the subscriber to acknowledge receipt
before resending the message. In the interval after the
message is delivered and before it is acknowledged, it is
considered to be outstanding. During that time period, the
message will not be redelivered (on a best-effort basis).
For pull subscriptions, this value is used as the initial
value for the ack deadline. To override this value for a
given message, call ``ModifyAckDeadline`` with the
corresponding ``ack_id`` if using non-streaming pull or send
the ``ack_id`` in a ``StreamingModifyAckDeadlineRequest`` if
using streaming pull. The minimum custom deadline you can
specify is 10 seconds. The maximum custom deadline you can
specify is 600 seconds (10 minutes). If this parameter is 0,
a default value of 10 seconds is used.
For push delivery, this value is also used to set the
request timeout for the call to the push endpoint.
If the subscriber never acknowledges the message, the
Pub/Sub system will eventually redeliver the message.
retain_acked_messages (bool):
Indicates whether to retain acknowledged messages. If true,
then messages are not expunged from the subscription's
backlog, even if they are acknowledged, until they fall out
of the ``message_retention_duration`` window. This must be
true if you would like to [``Seek`` to a timestamp]
(https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
in the past to replay previously-acknowledged messages.
message_retention_duration (google.protobuf.duration_pb2.Duration):
How long to retain unacknowledged messages in the
subscription's backlog, from the moment a message is
published. If ``retain_acked_messages`` is true, then this
also configures the retention of acknowledged messages, and
thus configures how far back in time a ``Seek`` can be done.
Defaults to 7 days. Cannot be more than 7 days or less than
10 minutes.
labels (Sequence[google.pubsub_v1.types.Subscription.LabelsEntry]):
See <a
href="https://cloud.google.com/pubsub/docs/labels">
Creating and managing labels</a>.
enable_message_ordering (bool):
If true, messages published with the same ``ordering_key``
in ``PubsubMessage`` will be delivered to the subscribers in
the order in which they are received by the Pub/Sub system.
Otherwise, they may be delivered in any order.
expiration_policy (google.pubsub_v1.types.ExpirationPolicy):
A policy that specifies the conditions for this
subscription's expiration. A subscription is considered
active as long as any connected subscriber is successfully
consuming messages from the subscription or is issuing
operations on the subscription. If ``expiration_policy`` is
not set, a *default policy* with ``ttl`` of 31 days will be
used. The minimum allowed value for
``expiration_policy.ttl`` is 1 day.
filter (str):
An expression written in the Pub/Sub `filter
language <https://cloud.google.com/pubsub/docs/filtering>`__.
If non-empty, then only ``PubsubMessage``\ s whose
``attributes`` field matches the filter are delivered on
this subscription. If empty, then no messages are filtered
out.
dead_letter_policy (google.pubsub_v1.types.DeadLetterPolicy):
A policy that specifies the conditions for dead lettering
messages in this subscription. If dead_letter_policy is not
set, dead lettering is disabled.
The Cloud Pub/Sub service account associated with this
subscriptions's parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com)
must have permission to Acknowledge() messages on this
subscription.
retry_policy (google.pubsub_v1.types.RetryPolicy):
A policy that specifies how Pub/Sub retries
message delivery for this subscription.
If not set, the default retry policy is applied.
This generally implies that messages will be
retried as soon as possible for healthy
subscribers. RetryPolicy will be triggered on
NACKs or acknowledgement deadline exceeded
events for a given message.
detached (bool):
Indicates whether the subscription is detached from its
topic. Detached subscriptions don't receive messages from
their topic and don't retain any backlog. ``Pull`` and
``StreamingPull`` requests will return FAILED_PRECONDITION.
If the subscription is a push subscription, pushes to the
endpoint will not be made.
enable_exactly_once_delivery (bool):
If true, Pub/Sub provides the following guarantees for the
delivery of a message with a given value of ``message_id``
on this subscription:
- The message sent to a subscriber is guaranteed not to be
resent before the message's acknowledgement deadline
expires.
- An acknowledged message will not be resent to a
subscriber.
Note that subscribers may still receive multiple copies of a
message when ``enable_exactly_once_delivery`` is true if the
message was published multiple times by a publisher client.
These copies are considered distinct by Pub/Sub and have
distinct ``message_id`` values.
topic_message_retention_duration (google.protobuf.duration_pb2.Duration):
Output only. Indicates the minimum duration for which a
message is retained after it is published to the
subscription's topic. If this field is set, messages
published to the subscription's topic in the last
``topic_message_retention_duration`` are always available to
subscribers. See the ``message_retention_duration`` field in
``Topic``. This field is set only in responses from the
server; it is ignored if it is set in any requests.
"""
name = proto.Field(proto.STRING, number=1,)
topic = proto.Field(proto.STRING, number=2,)
push_config = proto.Field(proto.MESSAGE, number=4, message="PushConfig",)
ack_deadline_seconds = proto.Field(proto.INT32, number=5,)
retain_acked_messages = proto.Field(proto.BOOL, number=7,)
message_retention_duration = proto.Field(
proto.MESSAGE, number=8, message=duration_pb2.Duration,
)
labels = proto.MapField(proto.STRING, proto.STRING, number=9,)
enable_message_ordering = proto.Field(proto.BOOL, number=10,)
expiration_policy = proto.Field(
proto.MESSAGE, number=11, message="ExpirationPolicy",
)
filter = proto.Field(proto.STRING, number=12,)
dead_letter_policy = proto.Field(
proto.MESSAGE, number=13, message="DeadLetterPolicy",
)
retry_policy = proto.Field(proto.MESSAGE, number=14, message="RetryPolicy",)
detached = proto.Field(proto.BOOL, number=15,)
enable_exactly_once_delivery = proto.Field(proto.BOOL, number=16,)
topic_message_retention_duration = proto.Field(
proto.MESSAGE, number=17, message=duration_pb2.Duration,
)
class RetryPolicy(proto.Message):
r"""A policy that specifies how Cloud Pub/Sub retries message delivery.
Retry delay will be exponential based on provided minimum and
maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff.
RetryPolicy will be triggered on NACKs or acknowledgement deadline
exceeded events for a given message.
Retry Policy is implemented on a best effort basis. At times, the
delay between consecutive deliveries may not match the
configuration. That is, delay can be more or less than configured
backoff.
Attributes:
minimum_backoff (google.protobuf.duration_pb2.Duration):
The minimum delay between consecutive
deliveries of a given message. Value should be
between 0 and 600 seconds. Defaults to 10
seconds.
maximum_backoff (google.protobuf.duration_pb2.Duration):
The maximum delay between consecutive
deliveries of a given message. Value should be
between 0 and 600 seconds. Defaults to 600
seconds.
"""
minimum_backoff = proto.Field(
proto.MESSAGE, number=1, message=duration_pb2.Duration,
)
maximum_backoff = proto.Field(
proto.MESSAGE, number=2, message=duration_pb2.Duration,
)
class DeadLetterPolicy(proto.Message):
r"""Dead lettering is done on a best effort basis. The same
message might be dead lettered multiple times.
If validation on any of the fields fails at subscription
creation/updation, the create/update subscription request will
fail.
Attributes:
dead_letter_topic (str):
The name of the topic to which dead letter messages should
be published. Format is
``projects/{project}/topics/{topic}``.The Cloud Pub/Sub
service account associated with the enclosing subscription's
parent project (i.e.,
service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com)
must have permission to Publish() to this topic.
The operation will fail if the topic does not exist. Users
should ensure that there is a subscription attached to this
topic since messages published to a topic with no
subscriptions are lost.
max_delivery_attempts (int):
The maximum number of delivery attempts for any message. The
value must be between 5 and 100.
The number of delivery attempts is defined as 1 + (the sum
of number of NACKs and number of times the acknowledgement
deadline has been exceeded for the message).
A NACK is any call to ModifyAckDeadline with a 0 deadline.
Note that client libraries may automatically extend
ack_deadlines.
This field will be honored on a best effort basis.
If this parameter is 0, a default value of 5 is used.
"""
dead_letter_topic = proto.Field(proto.STRING, number=1,)
max_delivery_attempts = proto.Field(proto.INT32, number=2,)
class ExpirationPolicy(proto.Message):
r"""A policy that specifies the conditions for resource
expiration (i.e., automatic resource deletion).
Attributes:
ttl (google.protobuf.duration_pb2.Duration):
Specifies the "time-to-live" duration for an associated
resource. The resource expires if it is not active for a
period of ``ttl``. The definition of "activity" depends on
the type of the associated resource. The minimum and maximum
allowed values for ``ttl`` depend on the type of the
associated resource, as well. If ``ttl`` is not set, the
associated resource never expires.
"""
ttl = proto.Field(proto.MESSAGE, number=1, message=duration_pb2.Duration,)
class PushConfig(proto.Message):
r"""Configuration for a push delivery endpoint.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes:
push_endpoint (str):
A URL locating the endpoint to which messages should be
pushed. For example, a Webhook endpoint might use
``https://example.com/push``.
attributes (Sequence[google.pubsub_v1.types.PushConfig.AttributesEntry]):
Endpoint configuration attributes that can be used to
control different aspects of the message delivery.
The only currently supported attribute is
``x-goog-version``, which you can use to change the format
of the pushed message. This attribute indicates the version
of the data expected by the endpoint. This controls the
shape of the pushed message (i.e., its fields and metadata).
If not present during the ``CreateSubscription`` call, it
will default to the version of the Pub/Sub API used to make
such call. If not present in a ``ModifyPushConfig`` call,
its value will not be changed. ``GetSubscription`` calls
will always return a valid version, even if the subscription
was created without this attribute.
The only supported values for the ``x-goog-version``
attribute are:
- ``v1beta1``: uses the push format defined in the v1beta1
Pub/Sub API.
- ``v1`` or ``v1beta2``: uses the push format defined in
the v1 Pub/Sub API.
For example:
.. raw:: html
<pre><code>attributes { "x-goog-version": "v1" } </code></pre>
oidc_token (google.pubsub_v1.types.PushConfig.OidcToken):
If specified, Pub/Sub will generate and attach an OIDC JWT
token as an ``Authorization`` header in the HTTP request for
every pushed message.
This field is a member of `oneof`_ ``authentication_method``.
"""
class OidcToken(proto.Message):
r"""Contains information needed for generating an `OpenID Connect
token <https://developers.google.com/identity/protocols/OpenIDConnect>`__.
Attributes:
service_account_email (str):
`Service account
email <https://cloud.google.com/iam/docs/service-accounts>`__
to be used for generating the OIDC token. The caller (for
CreateSubscription, UpdateSubscription, and ModifyPushConfig
RPCs) must have the iam.serviceAccounts.actAs permission for
the service account.
audience (str):
Audience to be used when generating OIDC
token. The audience claim identifies the
recipients that the JWT is intended for. The
audience value is a single case-sensitive
string. Having multiple values (array) for the
audience field is not supported. More info about
the OIDC JWT token audience here:
https://tools.ietf.org/html/rfc7519#section-4.1.3
Note: if not specified, the Push endpoint URL
will be used.
"""
service_account_email = proto.Field(proto.STRING, number=1,)
audience = proto.Field(proto.STRING, number=2,)
push_endpoint = proto.Field(proto.STRING, number=1,)
attributes = proto.MapField(proto.STRING, proto.STRING, number=2,)
oidc_token = proto.Field(
proto.MESSAGE, number=3, oneof="authentication_method", message=OidcToken,
)
class ReceivedMessage(proto.Message):
r"""A message and its corresponding acknowledgment ID.
Attributes:
ack_id (str):
This ID can be used to acknowledge the
received message.
message (google.pubsub_v1.types.PubsubMessage):
The message.
delivery_attempt (int):
The approximate number of times that Cloud Pub/Sub has
attempted to deliver the associated message to a subscriber.
More precisely, this is 1 + (number of NACKs) + (number of
ack_deadline exceeds) for this message.
A NACK is any call to ModifyAckDeadline with a 0 deadline.
An ack_deadline exceeds event is whenever a message is not
acknowledged within ack_deadline. Note that ack_deadline is
initially Subscription.ackDeadlineSeconds, but may get
extended automatically by the client library.
Upon the first delivery of a given message,
``delivery_attempt`` will have a value of 1. The value is
calculated at best effort and is approximate.
If a DeadLetterPolicy is not set on the subscription, this
will be 0.
"""
ack_id = proto.Field(proto.STRING, number=1,)
message = proto.Field(proto.MESSAGE, number=2, message="PubsubMessage",)
delivery_attempt = proto.Field(proto.INT32, number=3,)
class GetSubscriptionRequest(proto.Message):
r"""Request for the GetSubscription method.
Attributes:
subscription (str):
Required. The name of the subscription to get. Format is
``projects/{project}/subscriptions/{sub}``.
"""
subscription = proto.Field(proto.STRING, number=1,)
class UpdateSubscriptionRequest(proto.Message):
r"""Request for the UpdateSubscription method.
Attributes:
subscription (google.pubsub_v1.types.Subscription):
Required. The updated subscription object.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Required. Indicates which fields in the
provided subscription to update. Must be
specified and non-empty.
"""
subscription = proto.Field(proto.MESSAGE, number=1, message="Subscription",)
update_mask = proto.Field(
proto.MESSAGE, number=2, message=field_mask_pb2.FieldMask,
)
class ListSubscriptionsRequest(proto.Message):
r"""Request for the ``ListSubscriptions`` method.
Attributes:
project (str):
Required. The name of the project in which to list
subscriptions. Format is ``projects/{project-id}``.
page_size (int):
Maximum number of subscriptions to return.
page_token (str):
The value returned by the last
``ListSubscriptionsResponse``; indicates that this is a
continuation of a prior ``ListSubscriptions`` call, and that
the system should return the next page of data.
"""
project = proto.Field(proto.STRING, number=1,)
page_size = proto.Field(proto.INT32, number=2,)
page_token = proto.Field(proto.STRING, number=3,)
class ListSubscriptionsResponse(proto.Message):
r"""Response for the ``ListSubscriptions`` method.
Attributes:
subscriptions (Sequence[google.pubsub_v1.types.Subscription]):
The subscriptions that match the request.
next_page_token (str):
If not empty, indicates that there may be more subscriptions
that match the request; this value should be passed in a new
``ListSubscriptionsRequest`` to get more subscriptions.
"""
@property
def raw_page(self):
return self
subscriptions = proto.RepeatedField(
proto.MESSAGE, number=1, message="Subscription",
)
next_page_token = proto.Field(proto.STRING, number=2,)
class DeleteSubscriptionRequest(proto.Message):
r"""Request for the DeleteSubscription method.
Attributes:
subscription (str):
Required. The subscription to delete. Format is
``projects/{project}/subscriptions/{sub}``.
"""
subscription = proto.Field(proto.STRING, number=1,)
class ModifyPushConfigRequest(proto.Message):
r"""Request for the ModifyPushConfig method.
Attributes:
subscription (str):
Required. The name of the subscription. Format is
``projects/{project}/subscriptions/{sub}``.
push_config (google.pubsub_v1.types.PushConfig):
Required. The push configuration for future deliveries.
An empty ``pushConfig`` indicates that the Pub/Sub system
should stop pushing messages from the given subscription and
allow messages to be pulled and acknowledged - effectively
pausing the subscription if ``Pull`` or ``StreamingPull`` is
not called.
"""
subscription = proto.Field(proto.STRING, number=1,)
push_config = proto.Field(proto.MESSAGE, number=2, message="PushConfig",)
class PullRequest(proto.Message):
r"""Request for the ``Pull`` method.
Attributes:
subscription (str):
Required. The subscription from which messages should be
pulled. Format is
``projects/{project}/subscriptions/{sub}``.
return_immediately (bool):
Optional. If this field set to true, the system will respond
immediately even if it there are no messages available to
return in the ``Pull`` response. Otherwise, the system may
wait (for a bounded amount of time) until at least one
message is available, rather than returning no messages.
Warning: setting this field to ``true`` is discouraged
because it adversely impacts the performance of ``Pull``
operations. We recommend that users do not set this field.
max_messages (int):
Required. The maximum number of messages to
return for this request. Must be a positive
integer. The Pub/Sub system may return fewer
than the number specified.
"""
subscription = proto.Field(proto.STRING, number=1,)
return_immediately = proto.Field(proto.BOOL, number=2,)
max_messages = proto.Field(proto.INT32, number=3,)
class PullResponse(proto.Message):
r"""Response for the ``Pull`` method.
Attributes:
received_messages (Sequence[google.pubsub_v1.types.ReceivedMessage]):
Received Pub/Sub messages. The list will be empty if there
are no more messages available in the backlog. For JSON, the
response can be entirely empty. The Pub/Sub system may
return fewer than the ``maxMessages`` requested even if
there are more messages available in the backlog.
"""
received_messages = proto.RepeatedField(
proto.MESSAGE, number=1, message="ReceivedMessage",
)
class ModifyAckDeadlineRequest(proto.Message):
r"""Request for the ModifyAckDeadline method.
Attributes:
subscription (str):
Required. The name of the subscription. Format is
``projects/{project}/subscriptions/{sub}``.
ack_ids (Sequence[str]):
Required. List of acknowledgment IDs.
ack_deadline_seconds (int):
Required. The new ack deadline with respect to the time this
request was sent to the Pub/Sub system. For example, if the
value is 10, the new ack deadline will expire 10 seconds
after the ``ModifyAckDeadline`` call was made. Specifying
zero might immediately make the message available for
delivery to another subscriber client. This typically
results in an increase in the rate of message redeliveries
(that is, duplicates). The minimum deadline you can specify
is 0 seconds. The maximum deadline you can specify is 600
seconds (10 minutes).
"""