Class: Google::Cloud::Pubsub::V1::PublisherClient

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

Overview

The service that an application uses to manipulate topics, and to send messages to a topic.

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: "") ⇒ PublisherClient

Returns a new instance of PublisherClient

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.



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

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(
    "publisher_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.pubsub.v1.Publisher",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      bundle_descriptors: BUNDLE_DESCRIPTORS,
      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)
  )
  @publisher_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Pubsub::V1::Publisher::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_topic = Google::Gax.create_api_call(
    @publisher_stub.method(:create_topic),
    defaults["create_topic"]
  )
  @update_topic = Google::Gax.create_api_call(
    @publisher_stub.method(:update_topic),
    defaults["update_topic"]
  )
  @publish = Google::Gax.create_api_call(
    @publisher_stub.method(:publish),
    defaults["publish"]
  )
  @get_topic = Google::Gax.create_api_call(
    @publisher_stub.method(:get_topic),
    defaults["get_topic"]
  )
  @list_topics = Google::Gax.create_api_call(
    @publisher_stub.method(:list_topics),
    defaults["list_topics"]
  )
  @list_topic_subscriptions = Google::Gax.create_api_call(
    @publisher_stub.method(:list_topic_subscriptions),
    defaults["list_topic_subscriptions"]
  )
  @delete_topic = Google::Gax.create_api_call(
    @publisher_stub.method(:delete_topic),
    defaults["delete_topic"]
  )
end

Instance Attribute Details

#iam_policy_stub ⇒ Google::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
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 45

class PublisherClient
  attr_reader :iam_policy_stub, :publisher_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_topics" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "topics"),
    "list_topic_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  BUNDLE_DESCRIPTORS = {
    "publish" => Google::Gax::BundleDescriptor.new(
      "messages",
      [
        "topic"
      ],
      subresponse_field: "message_ids")
  }.freeze

  private_constant :BUNDLE_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

  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 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(
      "publisher_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Publisher",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        bundle_descriptors: BUNDLE_DESCRIPTORS,
        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)
    )
    @publisher_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Pubsub::V1::Publisher::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_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:create_topic),
      defaults["create_topic"]
    )
    @update_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:update_topic),
      defaults["update_topic"]
    )
    @publish = Google::Gax.create_api_call(
      @publisher_stub.method(:publish),
      defaults["publish"]
    )
    @get_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:get_topic),
      defaults["get_topic"]
    )
    @list_topics = Google::Gax.create_api_call(
      @publisher_stub.method(:list_topics),
      defaults["list_topics"]
    )
    @list_topic_subscriptions = Google::Gax.create_api_call(
      @publisher_stub.method(:list_topic_subscriptions),
      defaults["list_topic_subscriptions"]
    )
    @delete_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:delete_topic),
      defaults["delete_topic"]
    )
  end

  # Service calls

  # Creates the given topic with the given name.
  #
  # @param name [String]
  #   The name of the topic. It must have the format
  #   +"projects/{project}/topics/{topic}"+. +{topic}+ must start with a letter,
  #   and contain only letters (+[A-Za-z]+), numbers (+[0-9]+), dashes (+-+),
  #   underscores (+_+), periods (+.+), tildes (+~+), plus (+++) or percent
  #   signs (+%+). It must be between 3 and 255 characters in length, and it
  #   must not start with +"goog"+.
  # @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::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_name = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_client.create_topic(formatted_name)

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

  # Updates an existing topic. Note that certain properties of a topic are not
  # modifiable.  Options settings follow the style guide:
  # NOTE:  The style guide requires body: "topic" 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 topic [Google::Pubsub::V1::Topic | Hash]
  #   The topic to update.
  #   A hash of the same form as `Google::Pubsub::V1::Topic`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided topic 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::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   topic = {}
  #   update_mask = {}
  #   response = publisher_client.update_topic(topic, update_mask)

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

  # Adds one or more messages to the topic. Returns +NOT_FOUND+ if the topic
  # does not exist. The message payload must not be empty; it must contain
  #  either a non-empty data field, or at least one attribute.
  #
  # @param topic [String]
  #   The messages in the request will be published on this topic.
  #   Format is +projects/{project}/topics/{topic}+.
  # @param messages [Array<Google::Pubsub::V1::PubsubMessage | Hash>]
  #   The messages to publish.
  #   A hash of the same form as `Google::Pubsub::V1::PubsubMessage`
  #   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::PublishResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   data = ''
  #   messages_element = { data: data }
  #   messages = [messages_element]
  #   response = publisher_client.publish(formatted_topic, messages)

  def publish \
      topic,
      messages,
      options: nil
    req = {
      topic: topic,
      messages: messages
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::PublishRequest)
    @publish.call(req, options)
  end

  # Gets the configuration of a topic.
  #
  # @param topic [String]
  #   The name of the topic to get.
  #   Format is +projects/{project}/topics/{topic}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_client.get_topic(formatted_topic)

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

  # Lists matching topics.
  #
  # @param project [String]
  #   The name of the cloud project that topics 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::Topic>]
  #   An enumerable of Google::Pubsub::V1::Topic 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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_project = Google::Cloud::Pubsub::V1::PublisherClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   publisher_client.list_topics(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   publisher_client.list_topics(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_topics \
      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::ListTopicsRequest)
    @list_topics.call(req, options)
  end

  # Lists the name of the subscriptions for this topic.
  #
  # @param topic [String]
  #   The name of the topic that subscriptions are attached to.
  #   Format is +projects/{project}/topics/{topic}+.
  # @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<String>]
  #   An enumerable of String 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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #
  #   # Iterate over all results.
  #   publisher_client.list_topic_subscriptions(formatted_topic).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   publisher_client.list_topic_subscriptions(formatted_topic).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

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

  # Deletes the topic with the given name. Returns +NOT_FOUND+ if the topic
  # does not exist. After a topic is deleted, a new topic may be created with
  # the same name; this is an entirely new topic with none of the old
  # configuration or subscriptions. Existing subscriptions to this topic are
  # not deleted, but their +topic+ field is set to +_deleted-topic_+.
  #
  # @param topic [String]
  #   Name of the topic to delete.
  #   Format is +projects/{project}/topics/{topic}+.
  # @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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   publisher_client.delete_topic(formatted_topic)

  def delete_topic \
      topic,
      options: nil
    req = {
      topic: topic
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteTopicRequest)
    @delete_topic.call(req, options)
    nil
  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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   policy = {}
  #   response = publisher_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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   permissions = []
  #   response = publisher_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

#publisher_stub ⇒ Google::Pubsub::V1::Publisher::Stub (readonly)

Returns:

  • (Google::Pubsub::V1::Publisher::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
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 45

class PublisherClient
  attr_reader :iam_policy_stub, :publisher_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_topics" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "topics"),
    "list_topic_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  BUNDLE_DESCRIPTORS = {
    "publish" => Google::Gax::BundleDescriptor.new(
      "messages",
      [
        "topic"
      ],
      subresponse_field: "message_ids")
  }.freeze

  private_constant :BUNDLE_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

  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 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(
      "publisher_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Publisher",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        bundle_descriptors: BUNDLE_DESCRIPTORS,
        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)
    )
    @publisher_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Pubsub::V1::Publisher::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_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:create_topic),
      defaults["create_topic"]
    )
    @update_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:update_topic),
      defaults["update_topic"]
    )
    @publish = Google::Gax.create_api_call(
      @publisher_stub.method(:publish),
      defaults["publish"]
    )
    @get_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:get_topic),
      defaults["get_topic"]
    )
    @list_topics = Google::Gax.create_api_call(
      @publisher_stub.method(:list_topics),
      defaults["list_topics"]
    )
    @list_topic_subscriptions = Google::Gax.create_api_call(
      @publisher_stub.method(:list_topic_subscriptions),
      defaults["list_topic_subscriptions"]
    )
    @delete_topic = Google::Gax.create_api_call(
      @publisher_stub.method(:delete_topic),
      defaults["delete_topic"]
    )
  end

  # Service calls

  # Creates the given topic with the given name.
  #
  # @param name [String]
  #   The name of the topic. It must have the format
  #   +"projects/{project}/topics/{topic}"+. +{topic}+ must start with a letter,
  #   and contain only letters (+[A-Za-z]+), numbers (+[0-9]+), dashes (+-+),
  #   underscores (+_+), periods (+.+), tildes (+~+), plus (+++) or percent
  #   signs (+%+). It must be between 3 and 255 characters in length, and it
  #   must not start with +"goog"+.
  # @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::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_name = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_client.create_topic(formatted_name)

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

  # Updates an existing topic. Note that certain properties of a topic are not
  # modifiable.  Options settings follow the style guide:
  # NOTE:  The style guide requires body: "topic" 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 topic [Google::Pubsub::V1::Topic | Hash]
  #   The topic to update.
  #   A hash of the same form as `Google::Pubsub::V1::Topic`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Indicates which fields in the provided topic 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::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   topic = {}
  #   update_mask = {}
  #   response = publisher_client.update_topic(topic, update_mask)

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

  # Adds one or more messages to the topic. Returns +NOT_FOUND+ if the topic
  # does not exist. The message payload must not be empty; it must contain
  #  either a non-empty data field, or at least one attribute.
  #
  # @param topic [String]
  #   The messages in the request will be published on this topic.
  #   Format is +projects/{project}/topics/{topic}+.
  # @param messages [Array<Google::Pubsub::V1::PubsubMessage | Hash>]
  #   The messages to publish.
  #   A hash of the same form as `Google::Pubsub::V1::PubsubMessage`
  #   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::PublishResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   data = ''
  #   messages_element = { data: data }
  #   messages = [messages_element]
  #   response = publisher_client.publish(formatted_topic, messages)

  def publish \
      topic,
      messages,
      options: nil
    req = {
      topic: topic,
      messages: messages
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::PublishRequest)
    @publish.call(req, options)
  end

  # Gets the configuration of a topic.
  #
  # @param topic [String]
  #   The name of the topic to get.
  #   Format is +projects/{project}/topics/{topic}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Topic]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_client.get_topic(formatted_topic)

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

  # Lists matching topics.
  #
  # @param project [String]
  #   The name of the cloud project that topics 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::Topic>]
  #   An enumerable of Google::Pubsub::V1::Topic 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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_project = Google::Cloud::Pubsub::V1::PublisherClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   publisher_client.list_topics(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   publisher_client.list_topics(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_topics \
      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::ListTopicsRequest)
    @list_topics.call(req, options)
  end

  # Lists the name of the subscriptions for this topic.
  #
  # @param topic [String]
  #   The name of the topic that subscriptions are attached to.
  #   Format is +projects/{project}/topics/{topic}+.
  # @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<String>]
  #   An enumerable of String 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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #
  #   # Iterate over all results.
  #   publisher_client.list_topic_subscriptions(formatted_topic).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   publisher_client.list_topic_subscriptions(formatted_topic).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

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

  # Deletes the topic with the given name. Returns +NOT_FOUND+ if the topic
  # does not exist. After a topic is deleted, a new topic may be created with
  # the same name; this is an entirely new topic with none of the old
  # configuration or subscriptions. Existing subscriptions to this topic are
  # not deleted, but their +topic+ field is set to +_deleted-topic_+.
  #
  # @param topic [String]
  #   Name of the topic to delete.
  #   Format is +projects/{project}/topics/{topic}+.
  # @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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   publisher_client.delete_topic(formatted_topic)

  def delete_topic \
      topic,
      options: nil
    req = {
      topic: topic
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteTopicRequest)
    @delete_topic.call(req, options)
    nil
  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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   policy = {}
  #   response = publisher_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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = publisher_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"
  #
  #   publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
  #   formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
  #   permissions = []
  #   response = publisher_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) 


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

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

.topic_path(project, topic) ⇒ String

Returns a fully-qualified topic resource name string.

Parameters:

  • project (String)
  • topic (String)

Returns:

  • (String) 


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

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

Instance Method Details

#create_topic(name, labels: nil, options: nil) ⇒ Google::Pubsub::V1::Topic

Creates the given topic with the given name.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_name = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
response = publisher_client.create_topic(formatted_name)

Parameters:

  • name (String) —

    The name of the topic. It must have the format +"projects/project/topics/topic"+. +topic+ must start with a letter, and contain only letters (+[A-Za-z]+), numbers (+[0-9]+), dashes (+-+), underscores (+_+), periods (+.+), tildes (+~+), plus (+++) or percent signs (+%+). It must be between 3 and 255 characters in length, and it must not start with +"goog"+.

  • labels (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.



300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 300

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

#delete_topic(topic, options: nil) ⇒ Object

Deletes the topic with the given name. Returns +NOT_FOUND+ if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their +topic+ field is set to +deleted-topic+.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
publisher_client.delete_topic(formatted_topic)

Parameters:

  • topic (String) —

    Name of the topic to delete. Format is +projects/project/topics/topic+.

  • 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.



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

def delete_topic \
    topic,
    options: nil
  req = {
    topic: topic
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::DeleteTopicRequest)
  @delete_topic.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"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
response = publisher_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.



610
611
612
613
614
615
616
617
618
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 610

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_topic(topic, options: nil) ⇒ Google::Pubsub::V1::Topic

Gets the configuration of a topic.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
response = publisher_client.get_topic(formatted_topic)

Parameters:

  • topic (String) —

    The name of the topic to get. Format is +projects/project/topics/topic+.

  • 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.



408
409
410
411
412
413
414
415
416
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 408

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

#list_topic_subscriptions(topic, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<String>

Lists the name of the subscriptions for this topic.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")

# Iterate over all results.
publisher_client.list_topic_subscriptions(formatted_topic).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
publisher_client.list_topic_subscriptions(formatted_topic).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • topic (String) —

    The name of the topic that subscriptions are attached to. Format is +projects/project/topics/topic+.

  • 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<String>) —

    An enumerable of String 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.



508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 508

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

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

Lists matching topics.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_project = Google::Cloud::Pubsub::V1::PublisherClient.project_path("[PROJECT]")

# Iterate over all results.
publisher_client.list_topics(formatted_project).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
publisher_client.list_topics(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 topics 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::Topic>) —

    An enumerable of Google::Pubsub::V1::Topic 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.



457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 457

def list_topics \
    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::ListTopicsRequest)
  @list_topics.call(req, options)
end

#publish(topic, messages, options: nil) ⇒ Google::Pubsub::V1::PublishResponse

Adds one or more messages to the topic. Returns +NOT_FOUND+ if the topic does not exist. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

Examples:

require "google/cloud/pubsub/v1"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_topic = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
data = ''
messages_element = { data: data }
messages = [messages_element]
response = publisher_client.publish(formatted_topic, messages)

Parameters:

  • topic (String) —

    The messages in the request will be published on this topic. Format is +projects/project/topics/topic+.

  • messages (Array<Google::Pubsub::V1::PubsubMessage | Hash>) —

    The messages to publish. A hash of the same form as Google::Pubsub::V1::PubsubMessage 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.



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 379

def publish \
    topic,
    messages,
    options: nil
  req = {
    topic: topic,
    messages: messages
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Pubsub::V1::PublishRequest)
  @publish.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"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
policy = {}
response = publisher_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.



578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 578

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

#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"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
formatted_resource = Google::Cloud::Pubsub::V1::PublisherClient.topic_path("[PROJECT]", "[TOPIC]")
permissions = []
response = publisher_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.



646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 646

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_topic(topic, update_mask, options: nil) ⇒ Google::Pubsub::V1::Topic

Updates an existing topic. Note that certain properties of a topic are not modifiable. Options settings follow the style guide: NOTE: The style guide requires body: "topic" 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"

publisher_client = Google::Cloud::Pubsub::V1::Publisher.new
topic = {}
update_mask = {}
response = publisher_client.update_topic(topic, update_mask)

Parameters:

  • topic (Google::Pubsub::V1::Topic | Hash) —

    The topic to update. A hash of the same form as Google::Pubsub::V1::Topic can also be provided.

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

    Indicates which fields in the provided topic 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.



341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/google/cloud/pubsub/v1/publisher_client.rb', line 341

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