Class: Google::Apis::PubsubV1beta2::PubsubService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/pubsub_v1beta2/service.rb

Overview

Cloud Pub/Sub API

Provides reliable, many-to-many, asynchronous messaging between applications.

Examples:

require 'google/apis/pubsub_v1beta2'

Pubsub = Google::Apis::PubsubV1beta2 # Alias the module
service = Pubsub::PubsubService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializePubsubService


45
46
47
48
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 45

def initialize
  super('https://pubsub.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Empty

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


76
77
78
79
80
81
82
83
84
85
86
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 76

def acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+subscription}:acknowledge', options)
  command.request_representation = Google::Apis::PubsubV1beta2::AcknowledgeRequest::Representation
  command.request_object = acknowledge_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Empty
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::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. Note that for REST API requests, you must specify a name.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


119
120
121
122
123
124
125
126
127
128
129
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 119

def create_project_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::PubsubV1beta2::Subscription::Representation
  command.request_object = subscription_object
  command.response_representation = Google::Apis::PubsubV1beta2::Subscription::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Subscription
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Topic

Creates the given topic with the given name.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


485
486
487
488
489
490
491
492
493
494
495
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 485

def create_project_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:put, 'v1beta2/{+name}', options)
  command.request_representation = Google::Apis::PubsubV1beta2::Topic::Representation
  command.request_object = topic_object
  command.response_representation = Google::Apis::PubsubV1beta2::Topic::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Topic
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Empty

Deletes an existing subscription. All pending messages 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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


155
156
157
158
159
160
161
162
163
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 155

def delete_project_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+subscription}', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Empty
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Empty

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


521
522
523
524
525
526
527
528
529
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 521

def delete_project_topic(topic, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta2/{+topic}', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Empty
  command.params['topic'] = topic unless topic.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_subscription(subscription, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Subscription

Gets the configuration details of a subscription.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


185
186
187
188
189
190
191
192
193
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 185

def get_project_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+subscription}', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Subscription::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Subscription
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_subscription_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Policy

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


225
226
227
228
229
230
231
232
233
234
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 225

def get_project_subscription_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Topic

Gets the configuration of a topic.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


551
552
553
554
555
556
557
558
559
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 551

def get_project_topic(topic, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+topic}', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Topic::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Topic
  command.params['topic'] = topic unless topic.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_topic_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Policy

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


591
592
593
594
595
596
597
598
599
600
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 591

def get_project_topic_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::ListSubscriptionsResponse

Lists matching subscriptions.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


262
263
264
265
266
267
268
269
270
271
272
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 262

def list_project_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+project}/subscriptions', options)
  command.response_representation = Google::Apis::PubsubV1beta2::ListSubscriptionsResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::ListSubscriptionsResponse
  command.params['project'] = project unless project.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse

Lists the name of the subscriptions for this topic.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


776
777
778
779
780
781
782
783
784
785
786
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 776

def list_project_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+topic}/subscriptions', options)
  command.response_representation = Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::ListTopicSubscriptionsResponse
  command.params['topic'] = topic unless topic.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::ListTopicsResponse

Lists matching topics.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


628
629
630
631
632
633
634
635
636
637
638
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 628

def list_project_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta2/{+project}/topics', options)
  command.response_representation = Google::Apis::PubsubV1beta2::ListTopicsResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::ListTopicsResponse
  command.params['project'] = project unless project.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Empty

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


299
300
301
302
303
304
305
306
307
308
309
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 299

def modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+subscription}:modifyAckDeadline', options)
  command.request_representation = Google::Apis::PubsubV1beta2::ModifyAckDeadlineRequest::Representation
  command.request_object = modify_ack_deadline_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Empty
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Empty

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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


336
337
338
339
340
341
342
343
344
345
346
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 336

def modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+subscription}:modifyPushConfig', options)
  command.request_representation = Google::Apis::PubsubV1beta2::ModifyPushConfigRequest::Representation
  command.request_object = modify_push_config_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::Empty::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Empty
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


663
664
665
666
667
668
669
670
671
672
673
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 663

def publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+topic}:publish', options)
  command.request_representation = Google::Apis::PubsubV1beta2::PublishRequest::Representation
  command.request_object = publish_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::PublishResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::PublishResponse
  command.params['topic'] = topic unless topic.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::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.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


372
373
374
375
376
377
378
379
380
381
382
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 372

def pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+subscription}:pull', options)
  command.request_representation = Google::Apis::PubsubV1beta2::PullRequest::Representation
  command.request_object = pull_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::PullResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::PullResponse
  command.params['subscription'] = subscription unless subscription.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


408
409
410
411
412
413
414
415
416
417
418
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 408

def set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::PubsubV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Policy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


699
700
701
702
703
704
705
706
707
708
709
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 699

def set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::PubsubV1beta2::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::Policy::Representation
  command.response_class = Google::Apis::PubsubV1beta2::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


447
448
449
450
451
452
453
454
455
456
457
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 447

def test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::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. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


738
739
740
741
742
743
744
745
746
747
748
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 738

def test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta2/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::PubsubV1beta2::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end