Class: Google::Cloud::Pubsub::V1::SubscriberClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/v1/subscriber_client.rb

Overview

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the +Pull+ method.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"pubsub.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT =
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/pubsub"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ SubscriberClient

Returns a new instance of SubscriberClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc)

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>)

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash)

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric)

    The default timeout, in seconds, for calls made through this client.



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
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 166

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/iam/v1/iam_policy_services_pb"
  require "google/pubsub/v1/pubsub_services_pb"

  if channel || chan_creds || updater_proc
    warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
      "on 2017/09/08"
    credentials ||= channel
    credentials ||= chan_creds
    credentials ||= updater_proc
  end
  if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
    warn "`service_path` and `port` parameters are deprecated and will be removed"
  end

  credentials ||= Google::Cloud::Pubsub::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Pubsub::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "subscriber_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.pubsub.v1.Subscriber",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @iam_policy_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Iam::V1::IAMPolicy::Stub.method(:new)
  )
  @subscriber_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Pubsub::V1::Subscriber::Stub.method(:new)
  )

  @set_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:set_iam_policy),
    defaults["set_iam_policy"]
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:get_iam_policy),
    defaults["get_iam_policy"]
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @iam_policy_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"]
  )
  @create_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:create_subscription),
    defaults["create_subscription"]
  )
  @get_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:get_subscription),
    defaults["get_subscription"]
  )
  @update_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:update_subscription),
    defaults["update_subscription"]
  )
  @list_subscriptions = Google::Gax.create_api_call(
    @subscriber_stub.method(:list_subscriptions),
    defaults["list_subscriptions"]
  )
  @delete_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:delete_subscription),
    defaults["delete_subscription"]
  )
  @modify_ack_deadline = Google::Gax.create_api_call(
    @subscriber_stub.method(:modify_ack_deadline),
    defaults["modify_ack_deadline"]
  )
  @acknowledge = Google::Gax.create_api_call(
    @subscriber_stub.method(:acknowledge),
    defaults["acknowledge"]
  )
  @pull = Google::Gax.create_api_call(
    @subscriber_stub.method(:pull),
    defaults["pull"]
  )
  @streaming_pull = Google::Gax.create_api_call(
    @subscriber_stub.method(:streaming_pull),
    defaults["streaming_pull"]
  )
  @modify_push_config = Google::Gax.create_api_call(
    @subscriber_stub.method(:modify_push_config),
    defaults["modify_push_config"]
  )
  @list_snapshots = Google::Gax.create_api_call(
    @subscriber_stub.method(:list_snapshots),
    defaults["list_snapshots"]
  )
  @create_snapshot = Google::Gax.create_api_call(
    @subscriber_stub.method(:create_snapshot),
    defaults["create_snapshot"]
  )
  @update_snapshot = Google::Gax.create_api_call(
    @subscriber_stub.method(:update_snapshot),
    defaults["update_snapshot"]
  )
  @delete_snapshot = Google::Gax.create_api_call(
    @subscriber_stub.method(:delete_snapshot),
    defaults["delete_snapshot"]
  )
  @seek = Google::Gax.create_api_call(
    @subscriber_stub.method(:seek),
    defaults["seek"]
  )
end

Instance Attribute Details

#iam_policy_stubGoogle::Iam::V1::IAMPolicy::Stub (readonly)

Returns:

  • (Google::Iam::V1::IAMPolicy::Stub)


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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 45

class SubscriberClient
  attr_reader :iam_policy_stub, :subscriber_stub

  # The default address of the service.
  SERVICE_ADDRESS = "pubsub.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions"),
    "list_snapshots" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "snapshots")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/pubsub"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SNAPSHOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/snapshots/{snapshot}"
  )

  private_constant :SNAPSHOT_PATH_TEMPLATE

  SUBSCRIPTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/subscriptions/{subscription}"
  )

  private_constant :SUBSCRIPTION_PATH_TEMPLATE

  TOPIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/topics/{topic}"
  )

  private_constant :TOPIC_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified snapshot resource name string.
  # @param project [String]
  # @param snapshot [String]
  # @return [String]
  def self.snapshot_path project, snapshot
    SNAPSHOT_PATH_TEMPLATE.render(
      :"project" => project,
      :"snapshot" => snapshot
    )
  end

  # Returns a fully-qualified subscription resource name string.
  # @param project [String]
  # @param subscription [String]
  # @return [String]
  def self.subscription_path project, subscription
    SUBSCRIPTION_PATH_TEMPLATE.render(
      :"project" => project,
      :"subscription" => subscription
    )
  end

  # Returns a fully-qualified topic resource name string.
  # @param project [String]
  # @param topic [String]
  # @return [String]
  def self.topic_path project, topic
    TOPIC_PATH_TEMPLATE.render(
      :"project" => project,
      :"topic" => topic
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      updater_proc: nil,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/iam/v1/iam_policy_services_pb"
    require "google/pubsub/v1/pubsub_services_pb"

    if channel || chan_creds || updater_proc
      warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
        "on 2017/09/08"
      credentials ||= channel
      credentials ||= chan_creds
      credentials ||= updater_proc
    end
    if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
      warn "`service_path` and `port` parameters are deprecated and will be removed"
    end

    credentials ||= Google::Cloud::Pubsub::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Pubsub::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "subscriber_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Subscriber",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @iam_policy_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Iam::V1::IAMPolicy::Stub.method(:new)
    )
    @subscriber_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Pubsub::V1::Subscriber::Stub.method(:new)
    )

    @set_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:set_iam_policy),
      defaults["set_iam_policy"]
    )
    @get_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:get_iam_policy),
      defaults["get_iam_policy"]
    )
    @test_iam_permissions = Google::Gax.create_api_call(
      @iam_policy_stub.method(:test_iam_permissions),
      defaults["test_iam_permissions"]
    )
    @create_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_subscription),
      defaults["create_subscription"]
    )
    @get_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:get_subscription),
      defaults["get_subscription"]
    )
    @update_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:update_subscription),
      defaults["update_subscription"]
    )
    @list_subscriptions = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_subscriptions),
      defaults["list_subscriptions"]
    )
    @delete_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_subscription),
      defaults["delete_subscription"]
    )
    @modify_ack_deadline = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_ack_deadline),
      defaults["modify_ack_deadline"]
    )
    @acknowledge = Google::Gax.create_api_call(
      @subscriber_stub.method(:acknowledge),
      defaults["acknowledge"]
    )
    @pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:pull),
      defaults["pull"]
    )
    @streaming_pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:streaming_pull),
      defaults["streaming_pull"]
    )
    @modify_push_config = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_push_config),
      defaults["modify_push_config"]
    )
    @list_snapshots = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_snapshots),
      defaults["list_snapshots"]
    )
    @create_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_snapshot),
      defaults["create_snapshot"]
    )
    @update_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:update_snapshot),
      defaults["update_snapshot"]
    )
    @delete_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_snapshot),
      defaults["delete_snapshot"]
    )
    @seek = Google::Gax.create_api_call(
      @subscriber_stub.method(:seek),
      defaults["seek"]
    )
  end

  # Service calls

  # Creates a subscription to a given topic.
  # If the subscription already exists, returns +ALREADY_EXISTS+.
  # If the corresponding topic doesn't exist, returns +NOT_FOUND+.
  #
  # If the name is not provided in the request, the server will assign a random
  # name for this subscription on the same project as the topic, conforming
  # to the
  # [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
  # The generated name is populated in the returned Subscription object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param name [String]
  #   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"+.
  # @param topic [String]
  #   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.
  # @param push_config [Google::Pubsub::V1::PushConfig | Hash]
  #   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.
  #   A hash of the same form as `Google::Pubsub::V1::PushConfig`
  #   can also be provided.
  # @param ack_deadline_seconds [Integer]
  #   This value is the maximum time after a subscriber receives a message
  #   before the subscriber should acknowledge the message. After message
  #   delivery but before the ack deadline expires and before the message is
  #   acknowledged, it is an outstanding message and will not be delivered
  #   again during that time (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
  #   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.
  # @param retain_acked_messages [true, false]
  #   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.
  # @param message_retention_duration [Google::Protobuf::Duration | Hash]
  #   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.
  #   A hash of the same form as `Google::Protobuf::Duration`
  #   can also be provided.
  # @param labels [Hash{String => String}]
  #   User labels.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   formatted_topic = Google::Cloud::Pubsub::V1::SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = subscriber_client.create_subscription(formatted_name, formatted_topic)

  def create_subscription \
      name,
      topic,
      push_config: nil,
      ack_deadline_seconds: nil,
      retain_acked_messages: nil,
      message_retention_duration: nil,
      labels: nil,
      options: nil
    req = {
      name: name,
      topic: topic,
      push_config: push_config,
      ack_deadline_seconds: ack_deadline_seconds,
      retain_acked_messages: retain_acked_messages,
      message_retention_duration: message_retention_duration,
      labels: labels
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::Subscription)
    @create_subscription.call(req, options)
  end

  # Gets the configuration details of a subscription.
  #
  # @param subscription [String]
  #   The name of the subscription to get.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_subscription(formatted_subscription)

  def get_subscription \
      subscription,
      options: nil
    req = {
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::GetSubscriptionRequest)
    @get_subscription.call(req, options)
  end

  # Updates an existing subscription. Note that certain properties of a
  # subscription, such as its topic, are not modifiable.
  # NOTE:  The style guide requires body: "subscription" instead of body: "*".
  # Keeping the latter for internal consistency in V1, however it should be
  # corrected in V2.  See
  # https://cloud.google.com/apis/design/standard_methods#update for details.
  #
  # @param subscription [Google::Pubsub::V1::Subscription | Hash]
  #   The updated subscription object.
  #   A hash of the same form as `Google::Pubsub::V1::Subscription`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided subscription to update.
  #   Must be specified and non-empty.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   subscription = {}
  #   update_mask = {}
  #   response = subscriber_client.update_subscription(subscription, update_mask)

  def update_subscription \
      subscription,
      update_mask,
      options: nil
    req = {
      subscription: subscription,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSubscriptionRequest)
    @update_subscription.call(req, options)
  end

  # Lists matching subscriptions.
  #
  # @param project [String]
  #   The name of the cloud project that subscriptions belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>]
  #   An enumerable of Google::Pubsub::V1::Subscription instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_subscriptions(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_subscriptions \
      project,
      page_size: nil,
      options: nil
    req = {
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSubscriptionsRequest)
    @list_subscriptions.call(req, options)
  end

  # Deletes an existing subscription. All messages retained in the subscription
  # are immediately dropped. Calls to +Pull+ after deletion will return
  # +NOT_FOUND+. After a subscription is deleted, a new one may be created with
  # the same name, but the new one has no association with the old
  # subscription or its topic unless the same topic is specified.
  #
  # @param subscription [String]
  #   The subscription to delete.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   subscriber_client.delete_subscription(formatted_subscription)

  def delete_subscription \
      subscription,
      options: nil
    req = {
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSubscriptionRequest)
    @delete_subscription.call(req, options)
    nil
  end

  # Modifies the ack deadline for a specific message. This method is useful
  # to indicate that more time is needed to process a message by the
  # subscriber, or to make the message available for redelivery if the
  # processing was interrupted. Note that this does not modify the
  # subscription-level +ackDeadlineSeconds+ used for subsequent messages.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   List of acknowledgment IDs.
  # @param ack_deadline_seconds [Integer]
  #   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 may immediately make the message available for
  #   another pull request.
  #   The minimum deadline you can specify is 0 seconds.
  #   The maximum deadline you can specify is 600 seconds (10 minutes).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   ack_deadline_seconds = 0
  #   subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

  def modify_ack_deadline \
      subscription,
      ack_ids,
      ack_deadline_seconds,
      options: nil
    req = {
      subscription: subscription,
      ack_ids: ack_ids,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyAckDeadlineRequest)
    @modify_ack_deadline.call(req, options)
    nil
  end

  # Acknowledges the messages associated with the +ack_ids+ in the
  # +AcknowledgeRequest+. The Pub/Sub system can remove the relevant messages
  # from the subscription.
  #
  # Acknowledging a message whose ack deadline has expired may succeed,
  # but such a message may be redelivered later. Acknowledging a message more
  # than once will not result in an error.
  #
  # @param subscription [String]
  #   The subscription whose message is being acknowledged.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   The acknowledgment ID for the messages being acknowledged that was returned
  #   by the Pub/Sub system in the +Pull+ response. Must not be empty.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   subscriber_client.acknowledge(formatted_subscription, ack_ids)

  def acknowledge \
      subscription,
      ack_ids,
      options: nil
    req = {
      subscription: subscription,
      ack_ids: ack_ids
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::AcknowledgeRequest)
    @acknowledge.call(req, options)
    nil
  end

  # Pulls messages from the server. Returns an empty list if there are no
  # messages available in the backlog. The server may return +UNAVAILABLE+ if
  # there are too many concurrent pull requests pending for the given
  # subscription.
  #
  # @param subscription [String]
  #   The subscription from which messages should be pulled.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param max_messages [Integer]
  #   The maximum number of messages returned for this request. The Pub/Sub
  #   system may return fewer than the number specified.
  # @param return_immediately [true, false]
  #   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. The
  #   client may cancel the request if it does not wish to wait any longer for
  #   the response.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::PullResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   max_messages = 0
  #   response = subscriber_client.pull(formatted_subscription, max_messages)

  def pull \
      subscription,
      max_messages,
      return_immediately: nil,
      options: nil
    req = {
      subscription: subscription,
      max_messages: max_messages,
      return_immediately: return_immediately
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::PullRequest)
    @pull.call(req, options)
  end

  # (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will
  # respond with UNIMPLEMENTED errors unless you have been invited to test
  # this feature. Contact cloud-pubsub@google.com with any questions.
  #
  # Establishes a stream with the server, which sends messages down to the
  # client. The client streams acknowledgements and ack deadline modifications
  # back to the server. The server will close the stream and return the status
  # on any error. The server may close the stream with status +OK+ to reassign
  # server-side resources, in which case, the client should re-establish the
  # stream. +UNAVAILABLE+ may also be returned in the case of a transient error
  # (e.g., a server restart). These should also be retried by the client. Flow
  # control can be achieved by configuring the underlying RPC channel.
  #
  # @param reqs [Enumerable<Google::Pubsub::V1::StreamingPullRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Pubsub::V1::StreamingPullResponse>]
  #   An enumerable of Google::Pubsub::V1::StreamingPullResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   stream_ack_deadline_seconds = 0
  #   request = { subscription: formatted_subscription, stream_ack_deadline_seconds: stream_ack_deadline_seconds }
  #   requests = [request]
  #   subscriber_client.streaming_pull(requests).each do |element|
  #     # Process element.
  #   end

  def streaming_pull reqs, options: nil
    request_protos = reqs.lazy.map do |req|
      Google::Gax::to_proto(req, Google::Pubsub::V1::StreamingPullRequest)
    end
    @streaming_pull.call(request_protos, options)
  end

  # Modifies the +PushConfig+ for a specified subscription.
  #
  # This may be used to change a push subscription to a pull one (signified by
  # an empty +PushConfig+) or vice versa, or change the endpoint URL and other
  # attributes of a push subscription. Messages will accumulate for delivery
  # continuously through the call regardless of changes to the +PushConfig+.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param push_config [Google::Pubsub::V1::PushConfig | Hash]
  #   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+ is not called.
  #   A hash of the same form as `Google::Pubsub::V1::PushConfig`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   push_config = {}
  #   subscriber_client.modify_push_config(formatted_subscription, push_config)

  def modify_push_config \
      subscription,
      push_config,
      options: nil
    req = {
      subscription: subscription,
      push_config: push_config
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyPushConfigRequest)
    @modify_push_config.call(req, options)
    nil
  end

  # Lists the existing snapshots.
  #
  # @param project [String]
  #   The name of the cloud project that snapshots belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Snapshot>]
  #   An enumerable of Google::Pubsub::V1::Snapshot instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_snapshots(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_snapshots(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_snapshots \
      project,
      page_size: nil,
      options: nil
    req = {
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSnapshotsRequest)
    @list_snapshots.call(req, options)
  end

  # Creates a snapshot from the requested subscription.
  # If the snapshot already exists, returns +ALREADY_EXISTS+.
  # If the requested subscription doesn't exist, returns +NOT_FOUND+.
  #
  # If the name is not provided in the request, the server will assign a random
  # name for this snapshot on the same project as the subscription, conforming
  # to the
  # [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
  # The generated name is populated in the returned Snapshot object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param name [String]
  #   Optional user-provided name for this snapshot.
  #   If the name is not provided in the request, the server will assign a random
  #   name for this snapshot on the same project as the subscription.
  #   Note that for REST API requests, you must specify a name.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param subscription [String]
  #   The subscription whose backlog the snapshot retains.
  #   Specifically, the created snapshot is guaranteed to retain:
  #    (a) The existing backlog on the subscription. More precisely, this is
  #        defined as the messages in the subscription's backlog that are
  #        unacknowledged upon the successful completion of the
  #        +CreateSnapshot+ request; as well as:
  #    (b) Any messages published to the subscription's topic following the
  #        successful completion of the CreateSnapshot request.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Snapshot]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.create_snapshot(formatted_name, formatted_subscription)

  def create_snapshot \
      name,
      subscription,
      options: nil
    req = {
      name: name,
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::CreateSnapshotRequest)
    @create_snapshot.call(req, options)
  end

  # Updates an existing snapshot. Note that certain properties of a snapshot
  # are not modifiable.
  # NOTE:  The style guide requires body: "snapshot" instead of body: "*".
  # Keeping the latter for internal consistency in V1, however it should be
  # corrected in V2.  See
  # https://cloud.google.com/apis/design/standard_methods#update for details.
  #
  # @param snapshot [Google::Pubsub::V1::Snapshot | Hash]
  #   The updated snpashot object.
  #   A hash of the same form as `Google::Pubsub::V1::Snapshot`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided snapshot to update.
  #   Must be specified and non-empty.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Snapshot]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   snapshot = {}
  #   update_mask = {}
  #   response = subscriber_client.update_snapshot(snapshot, update_mask)

  def update_snapshot \
      snapshot,
      update_mask,
      options: nil
    req = {
      snapshot: snapshot,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSnapshotRequest)
    @update_snapshot.call(req, options)
  end

  # Removes an existing snapshot. All messages retained in the snapshot
  # are immediately dropped. After a snapshot is deleted, a new one may be
  # created with the same name, but the new one has no association with the old
  # snapshot or its subscription, unless the same subscription is specified.
  #
  # @param snapshot [String]
  #   The name of the snapshot to delete.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_snapshot = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
  #   subscriber_client.delete_snapshot(formatted_snapshot)

  def delete_snapshot \
      snapshot,
      options: nil
    req = {
      snapshot: snapshot
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSnapshotRequest)
    @delete_snapshot.call(req, options)
    nil
  end

  # Seeks an existing subscription to a point in time or to a given snapshot,
  # whichever is provided in the request.
  #
  # @param subscription [String]
  #   The subscription to affect.
  # @param time [Google::Protobuf::Timestamp | Hash]
  #   The time to seek to.
  #   Messages retained in the subscription that were published before this
  #   time are marked as acknowledged, and messages retained in the
  #   subscription that were published after this time are marked as
  #   unacknowledged. Note that this operation affects only those messages
  #   retained in the subscription (configured by the combination of
  #   +message_retention_duration+ and +retain_acked_messages+). For example,
  #   if +time+ corresponds to a point before the message retention
  #   window (or to a point before the system's notion of the subscription
  #   creation time), only retained messages will be marked as unacknowledged,
  #   and already-expunged messages will not be restored.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param snapshot [String]
  #   The snapshot to seek to. The snapshot's topic must be the same as that of
  #   the provided subscription.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::SeekResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.seek(formatted_subscription)

  def seek \
      subscription,
      time: nil,
      snapshot: nil,
      options: nil
    req = {
      subscription: subscription,
      time: time,
      snapshot: snapshot
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::SeekRequest)
    @seek.call(req, options)
  end

  # Sets the access control policy on the specified resource. Replaces any
  # existing policy.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being specified.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param policy [Google::Iam::V1::Policy | Hash]
  #   REQUIRED: The complete policy to be applied to the +resource+. The size of
  #   the policy is limited to a few 10s of KB. An empty policy is a
  #   valid policy but certain Cloud Platform services (such as Projects)
  #   might reject them.
  #   A hash of the same form as `Google::Iam::V1::Policy`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   policy = {}
  #   response = subscriber_client.set_iam_policy(formatted_resource, policy)

  def set_iam_policy \
      resource,
      policy,
      options: nil
    req = {
      resource: resource,
      policy: policy
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
    @set_iam_policy.call(req, options)
  end

  # Gets the access control policy for a resource.
  # Returns an empty policy if the resource exists and does not have a policy
  # set.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_iam_policy(formatted_resource)

  def get_iam_policy \
      resource,
      options: nil
    req = {
      resource: resource
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
    @get_iam_policy.call(req, options)
  end

  # Returns permissions that a caller has on the specified resource.
  # If the resource does not exist, this will return an empty set of
  # permissions, not a NOT_FOUND error.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy detail is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param permissions [Array<String>]
  #   The set of permissions to check for the +resource+. Permissions with
  #   wildcards (such as '*' or 'storage.*') are not allowed. For more
  #   information see
  #   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   permissions = []
  #   response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

  def test_iam_permissions \
      resource,
      permissions,
      options: nil
    req = {
      resource: resource,
      permissions: permissions
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
    @test_iam_permissions.call(req, options)
  end
end

#subscriber_stubGoogle::Pubsub::V1::Subscriber::Stub (readonly)

Returns:

  • (Google::Pubsub::V1::Subscriber::Stub)


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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 45

class SubscriberClient
  attr_reader :iam_policy_stub, :subscriber_stub

  # The default address of the service.
  SERVICE_ADDRESS = "pubsub.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions"),
    "list_snapshots" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "snapshots")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/pubsub"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SNAPSHOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/snapshots/{snapshot}"
  )

  private_constant :SNAPSHOT_PATH_TEMPLATE

  SUBSCRIPTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/subscriptions/{subscription}"
  )

  private_constant :SUBSCRIPTION_PATH_TEMPLATE

  TOPIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/topics/{topic}"
  )

  private_constant :TOPIC_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified snapshot resource name string.
  # @param project [String]
  # @param snapshot [String]
  # @return [String]
  def self.snapshot_path project, snapshot
    SNAPSHOT_PATH_TEMPLATE.render(
      :"project" => project,
      :"snapshot" => snapshot
    )
  end

  # Returns a fully-qualified subscription resource name string.
  # @param project [String]
  # @param subscription [String]
  # @return [String]
  def self.subscription_path project, subscription
    SUBSCRIPTION_PATH_TEMPLATE.render(
      :"project" => project,
      :"subscription" => subscription
    )
  end

  # Returns a fully-qualified topic resource name string.
  # @param project [String]
  # @param topic [String]
  # @return [String]
  def self.topic_path project, topic
    TOPIC_PATH_TEMPLATE.render(
      :"project" => project,
      :"topic" => topic
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      updater_proc: nil,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/iam/v1/iam_policy_services_pb"
    require "google/pubsub/v1/pubsub_services_pb"

    if channel || chan_creds || updater_proc
      warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
        "on 2017/09/08"
      credentials ||= channel
      credentials ||= chan_creds
      credentials ||= updater_proc
    end
    if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
      warn "`service_path` and `port` parameters are deprecated and will be removed"
    end

    credentials ||= Google::Cloud::Pubsub::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Pubsub::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "subscriber_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Subscriber",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @iam_policy_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Iam::V1::IAMPolicy::Stub.method(:new)
    )
    @subscriber_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Pubsub::V1::Subscriber::Stub.method(:new)
    )

    @set_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:set_iam_policy),
      defaults["set_iam_policy"]
    )
    @get_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:get_iam_policy),
      defaults["get_iam_policy"]
    )
    @test_iam_permissions = Google::Gax.create_api_call(
      @iam_policy_stub.method(:test_iam_permissions),
      defaults["test_iam_permissions"]
    )
    @create_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_subscription),
      defaults["create_subscription"]
    )
    @get_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:get_subscription),
      defaults["get_subscription"]
    )
    @update_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:update_subscription),
      defaults["update_subscription"]
    )
    @list_subscriptions = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_subscriptions),
      defaults["list_subscriptions"]
    )
    @delete_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_subscription),
      defaults["delete_subscription"]
    )
    @modify_ack_deadline = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_ack_deadline),
      defaults["modify_ack_deadline"]
    )
    @acknowledge = Google::Gax.create_api_call(
      @subscriber_stub.method(:acknowledge),
      defaults["acknowledge"]
    )
    @pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:pull),
      defaults["pull"]
    )
    @streaming_pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:streaming_pull),
      defaults["streaming_pull"]
    )
    @modify_push_config = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_push_config),
      defaults["modify_push_config"]
    )
    @list_snapshots = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_snapshots),
      defaults["list_snapshots"]
    )
    @create_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_snapshot),
      defaults["create_snapshot"]
    )
    @update_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:update_snapshot),
      defaults["update_snapshot"]
    )
    @delete_snapshot = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_snapshot),
      defaults["delete_snapshot"]
    )
    @seek = Google::Gax.create_api_call(
      @subscriber_stub.method(:seek),
      defaults["seek"]
    )
  end

  # Service calls

  # Creates a subscription to a given topic.
  # If the subscription already exists, returns +ALREADY_EXISTS+.
  # If the corresponding topic doesn't exist, returns +NOT_FOUND+.
  #
  # If the name is not provided in the request, the server will assign a random
  # name for this subscription on the same project as the topic, conforming
  # to the
  # [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
  # The generated name is populated in the returned Subscription object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param name [String]
  #   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"+.
  # @param topic [String]
  #   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.
  # @param push_config [Google::Pubsub::V1::PushConfig | Hash]
  #   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.
  #   A hash of the same form as `Google::Pubsub::V1::PushConfig`
  #   can also be provided.
  # @param ack_deadline_seconds [Integer]
  #   This value is the maximum time after a subscriber receives a message
  #   before the subscriber should acknowledge the message. After message
  #   delivery but before the ack deadline expires and before the message is
  #   acknowledged, it is an outstanding message and will not be delivered
  #   again during that time (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
  #   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.
  # @param retain_acked_messages [true, false]
  #   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.
  # @param message_retention_duration [Google::Protobuf::Duration | Hash]
  #   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.
  #   A hash of the same form as `Google::Protobuf::Duration`
  #   can also be provided.
  # @param labels [Hash{String => String}]
  #   User labels.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   formatted_topic = Google::Cloud::Pubsub::V1::SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = subscriber_client.create_subscription(formatted_name, formatted_topic)

  def create_subscription \
      name,
      topic,
      push_config: nil,
      ack_deadline_seconds: nil,
      retain_acked_messages: nil,
      message_retention_duration: nil,
      labels: nil,
      options: nil
    req = {
      name: name,
      topic: topic,
      push_config: push_config,
      ack_deadline_seconds: ack_deadline_seconds,
      retain_acked_messages: retain_acked_messages,
      message_retention_duration: message_retention_duration,
      labels: labels
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::Subscription)
    @create_subscription.call(req, options)
  end

  # Gets the configuration details of a subscription.
  #
  # @param subscription [String]
  #   The name of the subscription to get.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_subscription(formatted_subscription)

  def get_subscription \
      subscription,
      options: nil
    req = {
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::GetSubscriptionRequest)
    @get_subscription.call(req, options)
  end

  # Updates an existing subscription. Note that certain properties of a
  # subscription, such as its topic, are not modifiable.
  # NOTE:  The style guide requires body: "subscription" instead of body: "*".
  # Keeping the latter for internal consistency in V1, however it should be
  # corrected in V2.  See
  # https://cloud.google.com/apis/design/standard_methods#update for details.
  #
  # @param subscription [Google::Pubsub::V1::Subscription | Hash]
  #   The updated subscription object.
  #   A hash of the same form as `Google::Pubsub::V1::Subscription`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided subscription to update.
  #   Must be specified and non-empty.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   subscription = {}
  #   update_mask = {}
  #   response = subscriber_client.update_subscription(subscription, update_mask)

  def update_subscription \
      subscription,
      update_mask,
      options: nil
    req = {
      subscription: subscription,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSubscriptionRequest)
    @update_subscription.call(req, options)
  end

  # Lists matching subscriptions.
  #
  # @param project [String]
  #   The name of the cloud project that subscriptions belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>]
  #   An enumerable of Google::Pubsub::V1::Subscription instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_subscriptions(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_subscriptions \
      project,
      page_size: nil,
      options: nil
    req = {
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSubscriptionsRequest)
    @list_subscriptions.call(req, options)
  end

  # Deletes an existing subscription. All messages retained in the subscription
  # are immediately dropped. Calls to +Pull+ after deletion will return
  # +NOT_FOUND+. After a subscription is deleted, a new one may be created with
  # the same name, but the new one has no association with the old
  # subscription or its topic unless the same topic is specified.
  #
  # @param subscription [String]
  #   The subscription to delete.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   subscriber_client.delete_subscription(formatted_subscription)

  def delete_subscription \
      subscription,
      options: nil
    req = {
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSubscriptionRequest)
    @delete_subscription.call(req, options)
    nil
  end

  # Modifies the ack deadline for a specific message. This method is useful
  # to indicate that more time is needed to process a message by the
  # subscriber, or to make the message available for redelivery if the
  # processing was interrupted. Note that this does not modify the
  # subscription-level +ackDeadlineSeconds+ used for subsequent messages.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   List of acknowledgment IDs.
  # @param ack_deadline_seconds [Integer]
  #   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 may immediately make the message available for
  #   another pull request.
  #   The minimum deadline you can specify is 0 seconds.
  #   The maximum deadline you can specify is 600 seconds (10 minutes).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   ack_deadline_seconds = 0
  #   subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

  def modify_ack_deadline \
      subscription,
      ack_ids,
      ack_deadline_seconds,
      options: nil
    req = {
      subscription: subscription,
      ack_ids: ack_ids,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyAckDeadlineRequest)
    @modify_ack_deadline.call(req, options)
    nil
  end

  # Acknowledges the messages associated with the +ack_ids+ in the
  # +AcknowledgeRequest+. The Pub/Sub system can remove the relevant messages
  # from the subscription.
  #
  # Acknowledging a message whose ack deadline has expired may succeed,
  # but such a message may be redelivered later. Acknowledging a message more
  # than once will not result in an error.
  #
  # @param subscription [String]
  #   The subscription whose message is being acknowledged.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   The acknowledgment ID for the messages being acknowledged that was returned
  #   by the Pub/Sub system in the +Pull+ response. Must not be empty.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   subscriber_client.acknowledge(formatted_subscription, ack_ids)

  def acknowledge \
      subscription,
      ack_ids,
      options: nil
    req = {
      subscription: subscription,
      ack_ids: ack_ids
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::AcknowledgeRequest)
    @acknowledge.call(req, options)
    nil
  end

  # Pulls messages from the server. Returns an empty list if there are no
  # messages available in the backlog. The server may return +UNAVAILABLE+ if
  # there are too many concurrent pull requests pending for the given
  # subscription.
  #
  # @param subscription [String]
  #   The subscription from which messages should be pulled.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param max_messages [Integer]
  #   The maximum number of messages returned for this request. The Pub/Sub
  #   system may return fewer than the number specified.
  # @param return_immediately [true, false]
  #   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. The
  #   client may cancel the request if it does not wish to wait any longer for
  #   the response.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::PullResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   max_messages = 0
  #   response = subscriber_client.pull(formatted_subscription, max_messages)

  def pull \
      subscription,
      max_messages,
      return_immediately: nil,
      options: nil
    req = {
      subscription: subscription,
      max_messages: max_messages,
      return_immediately: return_immediately
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::PullRequest)
    @pull.call(req, options)
  end

  # (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will
  # respond with UNIMPLEMENTED errors unless you have been invited to test
  # this feature. Contact cloud-pubsub@google.com with any questions.
  #
  # Establishes a stream with the server, which sends messages down to the
  # client. The client streams acknowledgements and ack deadline modifications
  # back to the server. The server will close the stream and return the status
  # on any error. The server may close the stream with status +OK+ to reassign
  # server-side resources, in which case, the client should re-establish the
  # stream. +UNAVAILABLE+ may also be returned in the case of a transient error
  # (e.g., a server restart). These should also be retried by the client. Flow
  # control can be achieved by configuring the underlying RPC channel.
  #
  # @param reqs [Enumerable<Google::Pubsub::V1::StreamingPullRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Pubsub::V1::StreamingPullResponse>]
  #   An enumerable of Google::Pubsub::V1::StreamingPullResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   stream_ack_deadline_seconds = 0
  #   request = { subscription: formatted_subscription, stream_ack_deadline_seconds: stream_ack_deadline_seconds }
  #   requests = [request]
  #   subscriber_client.streaming_pull(requests).each do |element|
  #     # Process element.
  #   end

  def streaming_pull reqs, options: nil
    request_protos = reqs.lazy.map do |req|
      Google::Gax::to_proto(req, Google::Pubsub::V1::StreamingPullRequest)
    end
    @streaming_pull.call(request_protos, options)
  end

  # Modifies the +PushConfig+ for a specified subscription.
  #
  # This may be used to change a push subscription to a pull one (signified by
  # an empty +PushConfig+) or vice versa, or change the endpoint URL and other
  # attributes of a push subscription. Messages will accumulate for delivery
  # continuously through the call regardless of changes to the +PushConfig+.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param push_config [Google::Pubsub::V1::PushConfig | Hash]
  #   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+ is not called.
  #   A hash of the same form as `Google::Pubsub::V1::PushConfig`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   push_config = {}
  #   subscriber_client.modify_push_config(formatted_subscription, push_config)

  def modify_push_config \
      subscription,
      push_config,
      options: nil
    req = {
      subscription: subscription,
      push_config: push_config
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyPushConfigRequest)
    @modify_push_config.call(req, options)
    nil
  end

  # Lists the existing snapshots.
  #
  # @param project [String]
  #   The name of the cloud project that snapshots belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Snapshot>]
  #   An enumerable of Google::Pubsub::V1::Snapshot instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_snapshots(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_snapshots(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_snapshots \
      project,
      page_size: nil,
      options: nil
    req = {
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSnapshotsRequest)
    @list_snapshots.call(req, options)
  end

  # Creates a snapshot from the requested subscription.
  # If the snapshot already exists, returns +ALREADY_EXISTS+.
  # If the requested subscription doesn't exist, returns +NOT_FOUND+.
  #
  # If the name is not provided in the request, the server will assign a random
  # name for this snapshot on the same project as the subscription, conforming
  # to the
  # [resource name format](https://cloud.google.com/pubsub/docs/overview#names).
  # The generated name is populated in the returned Snapshot object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param name [String]
  #   Optional user-provided name for this snapshot.
  #   If the name is not provided in the request, the server will assign a random
  #   name for this snapshot on the same project as the subscription.
  #   Note that for REST API requests, you must specify a name.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param subscription [String]
  #   The subscription whose backlog the snapshot retains.
  #   Specifically, the created snapshot is guaranteed to retain:
  #    (a) The existing backlog on the subscription. More precisely, this is
  #        defined as the messages in the subscription's backlog that are
  #        unacknowledged upon the successful completion of the
  #        +CreateSnapshot+ request; as well as:
  #    (b) Any messages published to the subscription's topic following the
  #        successful completion of the CreateSnapshot request.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Snapshot]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.create_snapshot(formatted_name, formatted_subscription)

  def create_snapshot \
      name,
      subscription,
      options: nil
    req = {
      name: name,
      subscription: subscription
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::CreateSnapshotRequest)
    @create_snapshot.call(req, options)
  end

  # Updates an existing snapshot. Note that certain properties of a snapshot
  # are not modifiable.
  # NOTE:  The style guide requires body: "snapshot" instead of body: "*".
  # Keeping the latter for internal consistency in V1, however it should be
  # corrected in V2.  See
  # https://cloud.google.com/apis/design/standard_methods#update for details.
  #
  # @param snapshot [Google::Pubsub::V1::Snapshot | Hash]
  #   The updated snpashot object.
  #   A hash of the same form as `Google::Pubsub::V1::Snapshot`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided snapshot to update.
  #   Must be specified and non-empty.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Snapshot]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   snapshot = {}
  #   update_mask = {}
  #   response = subscriber_client.update_snapshot(snapshot, update_mask)

  def update_snapshot \
      snapshot,
      update_mask,
      options: nil
    req = {
      snapshot: snapshot,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSnapshotRequest)
    @update_snapshot.call(req, options)
  end

  # Removes an existing snapshot. All messages retained in the snapshot
  # are immediately dropped. After a snapshot is deleted, a new one may be
  # created with the same name, but the new one has no association with the old
  # snapshot or its subscription, unless the same subscription is specified.
  #
  # @param snapshot [String]
  #   The name of the snapshot to delete.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_snapshot = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
  #   subscriber_client.delete_snapshot(formatted_snapshot)

  def delete_snapshot \
      snapshot,
      options: nil
    req = {
      snapshot: snapshot
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSnapshotRequest)
    @delete_snapshot.call(req, options)
    nil
  end

  # Seeks an existing subscription to a point in time or to a given snapshot,
  # whichever is provided in the request.
  #
  # @param subscription [String]
  #   The subscription to affect.
  # @param time [Google::Protobuf::Timestamp | Hash]
  #   The time to seek to.
  #   Messages retained in the subscription that were published before this
  #   time are marked as acknowledged, and messages retained in the
  #   subscription that were published after this time are marked as
  #   unacknowledged. Note that this operation affects only those messages
  #   retained in the subscription (configured by the combination of
  #   +message_retention_duration+ and +retain_acked_messages+). For example,
  #   if +time+ corresponds to a point before the message retention
  #   window (or to a point before the system's notion of the subscription
  #   creation time), only retained messages will be marked as unacknowledged,
  #   and already-expunged messages will not be restored.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param snapshot [String]
  #   The snapshot to seek to. The snapshot's topic must be the same as that of
  #   the provided subscription.
  #   Format is +projects/{project}/snapshots/{snap}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::SeekResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.seek(formatted_subscription)

  def seek \
      subscription,
      time: nil,
      snapshot: nil,
      options: nil
    req = {
      subscription: subscription,
      time: time,
      snapshot: snapshot
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::SeekRequest)
    @seek.call(req, options)
  end

  # Sets the access control policy on the specified resource. Replaces any
  # existing policy.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being specified.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param policy [Google::Iam::V1::Policy | Hash]
  #   REQUIRED: The complete policy to be applied to the +resource+. The size of
  #   the policy is limited to a few 10s of KB. An empty policy is a
  #   valid policy but certain Cloud Platform services (such as Projects)
  #   might reject them.
  #   A hash of the same form as `Google::Iam::V1::Policy`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   policy = {}
  #   response = subscriber_client.set_iam_policy(formatted_resource, policy)

  def set_iam_policy \
      resource,
      policy,
      options: nil
    req = {
      resource: resource,
      policy: policy
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
    @set_iam_policy.call(req, options)
  end

  # Gets the access control policy for a resource.
  # Returns an empty policy if the resource exists and does not have a policy
  # set.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_iam_policy(formatted_resource)

  def get_iam_policy \
      resource,
      options: nil
    req = {
      resource: resource
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
    @get_iam_policy.call(req, options)
  end

  # Returns permissions that a caller has on the specified resource.
  # If the resource does not exist, this will return an empty set of
  # permissions, not a NOT_FOUND error.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy detail is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param permissions [Array<String>]
  #   The set of permissions to check for the +resource+. Permissions with
  #   wildcards (such as '*' or 'storage.*') are not allowed. For more
  #   information see
  #   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   permissions = []
  #   response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

  def test_iam_permissions \
      resource,
      permissions,
      options: nil
    req = {
      resource: resource,
      permissions: permissions
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
    @test_iam_permissions.call(req, options)
  end
end

Class Method Details

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String)


103
104
105
106
107
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 103

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.snapshot_path(project, snapshot) ⇒ String

Returns a fully-qualified snapshot resource name string.

Parameters:

  • project (String)
  • snapshot (String)

Returns:

  • (String)


113
114
115
116
117
118
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 113

def self.snapshot_path project, snapshot
  SNAPSHOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"snapshot" => snapshot
  )
end

.subscription_path(project, subscription) ⇒ String

Returns a fully-qualified subscription resource name string.

Parameters:

  • project (String)
  • subscription (String)

Returns:

  • (String)


124
125
126
127
128
129
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 124

def self.subscription_path project, subscription
  SUBSCRIPTION_PATH_TEMPLATE.render(
    :"project" => project,
    :"subscription" => subscription
  )
end

.topic_path(project, topic) ⇒ String

Returns a fully-qualified topic resource name string.

Parameters:

  • project (String)
  • topic (String)

Returns:

  • (String)


135
136
137
138
139
140
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 135

def self.topic_path project, topic
  TOPIC_PATH_TEMPLATE.render(
    :"project" => project,
    :"topic" => topic
  )
end

Instance Method Details

#acknowledge(subscription, ack_ids, options: nil) ⇒ Object

Acknowledges the messages associated with the +ack_ids+ in the +AcknowledgeRequest+. The Pub/Sub system can remove the relevant messages from the subscription.

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
ack_ids = []
subscriber_client.acknowledge(formatted_subscription, ack_ids)

Parameters:

  • subscription (String)

    The subscription whose message is being acknowledged. Format is +projects/project/subscriptions/sub+.

  • ack_ids (Array<String>)

    The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the +Pull+ response. Must not be empty.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



654
655
656
657
658
659
660
661
662
663
664
665
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 654

def acknowledge \
    subscription,
    ack_ids,
    options: nil
  req = {
    subscription: subscription,
    ack_ids: ack_ids
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::AcknowledgeRequest)
  @acknowledge.call(req, options)
  nil
end

#create_snapshot(name, subscription, options: nil) ⇒ Google::Pubsub::V1::Snapshot

Creates a snapshot from the requested subscription. If the snapshot already exists, returns +ALREADY_EXISTS+. If the requested subscription doesn't exist, returns +NOT_FOUND+.

If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format. The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.create_snapshot(formatted_name, formatted_subscription)

Parameters:

  • name (String)

    Optional user-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. Format is +projects/project/snapshots/snap+.

  • subscription (String)

    The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the +CreateSnapshot+ request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is +projects/project/subscriptions/sub+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



894
895
896
897
898
899
900
901
902
903
904
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 894

def create_snapshot \
    name,
    subscription,
    options: nil
  req = {
    name: name,
    subscription: subscription
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::CreateSnapshotRequest)
  @create_snapshot.call(req, options)
end

#create_subscription(name, topic, push_config: nil, ack_deadline_seconds: nil, retain_acked_messages: nil, message_retention_duration: nil, labels: nil, options: nil) ⇒ Google::Pubsub::V1::Subscription

Creates a subscription to a given topic. If the subscription already exists, returns +ALREADY_EXISTS+. If the corresponding topic doesn't exist, returns +NOT_FOUND+.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the resource name format. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_name = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
formatted_topic = Google::Cloud::Pubsub::V1::SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
response = subscriber_client.create_subscription(formatted_name, formatted_topic)

Parameters:

  • name (String)

    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 (String)

    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::PushConfig | Hash)

    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. A hash of the same form as Google::Pubsub::V1::PushConfig can also be provided.

  • ack_deadline_seconds (Integer)

    This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (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 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 (true, false)

    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.

  • message_retention_duration (Google::Protobuf::Duration | Hash)

    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. A hash of the same form as Google::Protobuf::Duration can also be provided.

  • labels (Hash{String => String})

    User labels.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 409

def create_subscription \
    name,
    topic,
    push_config: nil,
    ack_deadline_seconds: nil,
    retain_acked_messages: nil,
    message_retention_duration: nil,
    labels: nil,
    options: nil
  req = {
    name: name,
    topic: topic,
    push_config: push_config,
    ack_deadline_seconds: ack_deadline_seconds,
    retain_acked_messages: retain_acked_messages,
    message_retention_duration: message_retention_duration,
    labels: labels
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::Subscription)
  @create_subscription.call(req, options)
end

#delete_snapshot(snapshot, options: nil) ⇒ Object

Removes an existing snapshot. All messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_snapshot = Google::Cloud::Pubsub::V1::SubscriberClient.snapshot_path("[PROJECT]", "[SNAPSHOT]")
subscriber_client.delete_snapshot(formatted_snapshot)

Parameters:

  • snapshot (String)

    The name of the snapshot to delete. Format is +projects/project/snapshots/snap+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



966
967
968
969
970
971
972
973
974
975
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 966

def delete_snapshot \
    snapshot,
    options: nil
  req = {
    snapshot: snapshot
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSnapshotRequest)
  @delete_snapshot.call(req, options)
  nil
end

#delete_subscription(subscription, options: nil) ⇒ Object

Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to +Pull+ after deletion will return +NOT_FOUND+. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
subscriber_client.delete_subscription(formatted_subscription)

Parameters:

  • subscription (String)

    The subscription to delete. Format is +projects/project/subscriptions/sub+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



570
571
572
573
574
575
576
577
578
579
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 570

def delete_subscription \
    subscription,
    options: nil
  req = {
    subscription: subscription
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteSubscriptionRequest)
  @delete_subscription.call(req, options)
  nil
end

#get_iam_policy(resource, options: nil) ⇒ Google::Iam::V1::Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Iam::V1::Policy)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



1085
1086
1087
1088
1089
1090
1091
1092
1093
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 1085

def get_iam_policy \
    resource,
    options: nil
  req = {
    resource: resource
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
  @get_iam_policy.call(req, options)
end

#get_subscription(subscription, options: nil) ⇒ Google::Pubsub::V1::Subscription

Gets the configuration details of a subscription.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.get_subscription(formatted_subscription)

Parameters:

  • subscription (String)

    The name of the subscription to get. Format is +projects/project/subscriptions/sub+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



448
449
450
451
452
453
454
455
456
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 448

def get_subscription \
    subscription,
    options: nil
  req = {
    subscription: subscription
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::GetSubscriptionRequest)
  @get_subscription.call(req, options)
end

#list_snapshots(project, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Pubsub::V1::Snapshot>

Lists the existing snapshots.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")

# Iterate over all results.
subscriber_client.list_snapshots(formatted_project).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
subscriber_client.list_snapshots(formatted_project).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • project (String)

    The name of the cloud project that snapshots belong to. Format is +projects/project+.

  • page_size (Integer)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Pubsub::V1::Snapshot>)

    An enumerable of Google::Pubsub::V1::Snapshot instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



842
843
844
845
846
847
848
849
850
851
852
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 842

def list_snapshots \
    project,
    page_size: nil,
    options: nil
  req = {
    project: project,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSnapshotsRequest)
  @list_snapshots.call(req, options)
end

#list_subscriptions(project, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>

Lists matching subscriptions.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_project = Google::Cloud::Pubsub::V1::SubscriberClient.project_path("[PROJECT]")

# Iterate over all results.
subscriber_client.list_subscriptions(formatted_project).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • project (String)

    The name of the cloud project that subscriptions belong to. Format is +projects/project+.

  • page_size (Integer)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>)

    An enumerable of Google::Pubsub::V1::Subscription instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



538
539
540
541
542
543
544
545
546
547
548
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 538

def list_subscriptions \
    project,
    page_size: nil,
    options: nil
  req = {
    project: project,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::ListSubscriptionsRequest)
  @list_subscriptions.call(req, options)
end

#modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds, options: nil) ⇒ Object

Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level +ackDeadlineSeconds+ used for subsequent messages.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
ack_ids = []
ack_deadline_seconds = 0
subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

Parameters:

  • subscription (String)

    The name of the subscription. Format is +projects/project/subscriptions/sub+.

  • ack_ids (Array<String>)

    List of acknowledgment IDs.

  • ack_deadline_seconds (Integer)

    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 may immediately make the message available for another pull request. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



613
614
615
616
617
618
619
620
621
622
623
624
625
626
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 613

def modify_ack_deadline \
    subscription,
    ack_ids,
    ack_deadline_seconds,
    options: nil
  req = {
    subscription: subscription,
    ack_ids: ack_ids,
    ack_deadline_seconds: ack_deadline_seconds
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyAckDeadlineRequest)
  @modify_ack_deadline.call(req, options)
  nil
end

#modify_push_config(subscription, push_config, options: nil) ⇒ Object

Modifies the +PushConfig+ for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty +PushConfig+) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the +PushConfig+.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
push_config = {}
subscriber_client.modify_push_config(formatted_subscription, push_config)

Parameters:

  • subscription (String)

    The name of the subscription. Format is +projects/project/subscriptions/sub+.

  • push_config (Google::Pubsub::V1::PushConfig | Hash)

    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+ is not called. A hash of the same form as Google::Pubsub::V1::PushConfig can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



790
791
792
793
794
795
796
797
798
799
800
801
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 790

def modify_push_config \
    subscription,
    push_config,
    options: nil
  req = {
    subscription: subscription,
    push_config: push_config
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::ModifyPushConfigRequest)
  @modify_push_config.call(req, options)
  nil
end

#pull(subscription, max_messages, return_immediately: nil, options: nil) ⇒ Google::Pubsub::V1::PullResponse

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return +UNAVAILABLE+ if there are too many concurrent pull requests pending for the given subscription.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
max_messages = 0
response = subscriber_client.pull(formatted_subscription, max_messages)

Parameters:

  • subscription (String)

    The subscription from which messages should be pulled. Format is +projects/project/subscriptions/sub+.

  • max_messages (Integer)

    The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

  • return_immediately (true, false)

    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. The client may cancel the request if it does not wish to wait any longer for the response.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



698
699
700
701
702
703
704
705
706
707
708
709
710
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 698

def pull \
    subscription,
    max_messages,
    return_immediately: nil,
    options: nil
  req = {
    subscription: subscription,
    max_messages: max_messages,
    return_immediately: return_immediately
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::PullRequest)
  @pull.call(req, options)
end

#seek(subscription, time: nil, snapshot: nil, options: nil) ⇒ Google::Pubsub::V1::SeekResponse

Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.seek(formatted_subscription)

Parameters:

  • subscription (String)

    The subscription to affect.

  • time (Google::Protobuf::Timestamp | Hash)

    The time to seek to. Messages retained in the subscription that were published before this time are marked as acknowledged, and messages retained in the subscription that were published after this time are marked as unacknowledged. Note that this operation affects only those messages retained in the subscription (configured by the combination of +message_retention_duration+ and +retain_acked_messages+). For example, if +time+ corresponds to a point before the message retention window (or to a point before the system's notion of the subscription creation time), only retained messages will be marked as unacknowledged, and already-expunged messages will not be restored. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • snapshot (String)

    The snapshot to seek to. The snapshot's topic must be the same as that of the provided subscription. Format is +projects/project/snapshots/snap+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 1012

def seek \
    subscription,
    time: nil,
    snapshot: nil,
    options: nil
  req = {
    subscription: subscription,
    time: time,
    snapshot: snapshot
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::SeekRequest)
  @seek.call(req, options)
end

#set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
policy = {}
response = subscriber_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy is being specified. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

  • policy (Google::Iam::V1::Policy | Hash)

    REQUIRED: The complete policy to be applied to the +resource+. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. A hash of the same form as Google::Iam::V1::Policy can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Iam::V1::Policy)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 1053

def set_iam_policy \
    resource,
    policy,
    options: nil
  req = {
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
  @set_iam_policy.call(req, options)
end

#streaming_pull(reqs, options: nil) ⇒ Enumerable<Google::Pubsub::V1::StreamingPullResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

(EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status +OK+ to reassign server-side resources, in which case, the client should re-establish the stream. +UNAVAILABLE+ may also be returned in the case of a transient error (e.g., a server restart). These should also be retried by the client. Flow control can be achieved by configuring the underlying RPC channel.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_subscription = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
stream_ack_deadline_seconds = 0
request = { subscription: formatted_subscription, stream_ack_deadline_seconds: stream_ack_deadline_seconds }
requests = [request]
subscriber_client.streaming_pull(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



752
753
754
755
756
757
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 752

def streaming_pull reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Pubsub::V1::StreamingPullRequest)
  end
  @streaming_pull.call(request_protos, options)
end

#test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
formatted_resource = Google::Cloud::Pubsub::V1::SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
permissions = []
response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String)

    REQUIRED: The resource for which the policy detail is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

  • permissions (Array<String>)

    The set of permissions to check for the +resource+. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Iam::V1::TestIamPermissionsResponse)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 1121

def test_iam_permissions \
    resource,
    permissions,
    options: nil
  req = {
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
  @test_iam_permissions.call(req, options)
end

#update_snapshot(snapshot, update_mask, options: nil) ⇒ Google::Pubsub::V1::Snapshot

Updates an existing snapshot. Note that certain properties of a snapshot are not modifiable. NOTE: The style guide requires body: "snapshot" instead of body: "*". Keeping the latter for internal consistency in V1, however it should be corrected in V2. See https://cloud.google.com/apis/design/standard_methods#update for details.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
snapshot = {}
update_mask = {}
response = subscriber_client.update_snapshot(snapshot, update_mask)

Parameters:

  • snapshot (Google::Pubsub::V1::Snapshot | Hash)

    The updated snpashot object. A hash of the same form as Google::Pubsub::V1::Snapshot can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash)

    Indicates which fields in the provided snapshot to update. Must be specified and non-empty. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



935
936
937
938
939
940
941
942
943
944
945
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 935

def update_snapshot \
    snapshot,
    update_mask,
    options: nil
  req = {
    snapshot: snapshot,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSnapshotRequest)
  @update_snapshot.call(req, options)
end

#update_subscription(subscription, update_mask, options: nil) ⇒ Google::Pubsub::V1::Subscription

Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. NOTE: The style guide requires body: "subscription" instead of body: "*". Keeping the latter for internal consistency in V1, however it should be corrected in V2. See https://cloud.google.com/apis/design/standard_methods#update for details.

Examples:

require "google/cloud/pubsub/v1"

subscriber_client = Google::Cloud::Pubsub::V1::Subscriber.new
subscription = {}
update_mask = {}
response = subscriber_client.update_subscription(subscription, update_mask)

Parameters:

  • subscription (Google::Pubsub::V1::Subscription | Hash)

    The updated subscription object. A hash of the same form as Google::Pubsub::V1::Subscription can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash)

    Indicates which fields in the provided subscription to update. Must be specified and non-empty. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



487
488
489
490
491
492
493
494
495
496
497
# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 487

def update_subscription \
    subscription,
    update_mask,
    options: nil
  req = {
    subscription: subscription,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::UpdateSubscriptionRequest)
  @update_subscription.call(req, options)
end