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

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

Overview

Google 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

Constructor Details

#initializePubsubService

Returns a new instance of PubsubService.


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

def initialize
  super('https://pubsub.googleapis.com/', '')
end

Instance Attribute Details

#keyString

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String)

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.


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

def key
  @key
end

#quota_userString

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.


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.

Parameters:

  • subscription (String)

    The subscription whose message is being acknowledged.

  • acknowledge_request_object (Google::Apis::PubsubV1beta2::AcknowledgeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


681
682
683
684
685
686
687
688
689
690
691
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 681

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_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 for a given subscriber. 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.

Parameters:

  • name (String)

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

  • subscription_object (Google::Apis::PubsubV1beta2::Subscription) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


507
508
509
510
511
512
513
514
515
516
517
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 507

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

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

  • topic_object (Google::Apis::PubsubV1beta2::Topic) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

Parameters:

  • subscription (String)

    The subscription to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


611
612
613
614
615
616
617
618
619
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 611

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

Parameters:

  • topic (String)

    Name of the topic to delete.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


321
322
323
324
325
326
327
328
329
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 321

def delete_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_iam_policy_project_subscription(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Policy

Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being requested. resource is usually specified as a path, such as, projects/project/zones/zone/disks/ disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective GetIamPolicy rpc.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


430
431
432
433
434
435
436
437
438
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 430

def get_iam_policy_project_subscription(resource, 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being requested. resource is usually specified as a path, such as, projects/project/zones/zone/disks/ disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective GetIamPolicy rpc.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


110
111
112
113
114
115
116
117
118
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 110

def get_iam_policy_project_topic(resource, 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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

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

Gets the configuration details of a subscription.

Parameters:

  • subscription (String)

    The name of the subscription to get.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


539
540
541
542
543
544
545
546
547
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 539

def get_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_topic(topic, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::Topic

Gets the configuration of a topic.

Parameters:

  • topic (String)

    The name of the topic to get.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


249
250
251
252
253
254
255
256
257
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 249

def get_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

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

Lists matching subscriptions.

Parameters:

  • project (String)

    The name of the cloud project that subscriptions belong to.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of subscriptions to return.

  • page_token (String) (defaults to: nil)

    The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


575
576
577
578
579
580
581
582
583
584
585
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 575

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

Parameters:

  • topic (String)

    The name of the topic that subscriptions are attached to.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of subscription names to return.

  • page_token (String) (defaults to: nil)

    The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


357
358
359
360
361
362
363
364
365
366
367
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 357

def list_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_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::PubsubV1beta2::ListTopicsResponse

Lists matching topics.

Parameters:

  • project (String)

    The name of the cloud project that topics belong to.

  • page_size (Fixnum) (defaults to: nil)

    Maximum number of topics to return.

  • page_token (String) (defaults to: nil)

    The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


285
286
287
288
289
290
291
292
293
294
295
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 285

def list_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.

Parameters:

  • subscription (String)

    The name of the subscription.

  • modify_ack_deadline_request_object (Google::Apis::PubsubV1beta2::ModifyAckDeadlineRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


644
645
646
647
648
649
650
651
652
653
654
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 644

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.

Parameters:

  • subscription (String)

    The name of the subscription.

  • modify_push_config_request_object (Google::Apis::PubsubV1beta2::ModifyPushConfigRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


753
754
755
756
757
758
759
760
761
762
763
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 753

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.

Parameters:

  • topic (String)

    The messages in the request will be published on this topic.

  • publish_request_object (Google::Apis::PubsubV1beta2::PublishRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


217
218
219
220
221
222
223
224
225
226
227
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 217

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.

Parameters:

  • subscription (String)

    The subscription from which messages should be pulled.

  • pull_request_object (Google::Apis::PubsubV1beta2::PullRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


716
717
718
719
720
721
722
723
724
725
726
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 716

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

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being specified. resource is usually specified as a path, such as, projects/project/zones/zone/disks/ disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective SetIamPolicy rpc.

  • set_iam_policy_request_object (Google::Apis::PubsubV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


394
395
396
397
398
399
400
401
402
403
404
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 394

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

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy is being specified. resource is usually specified as a path, such as, projects/project/zones/zone/disks/ disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective SetIamPolicy rpc.

  • set_iam_policy_request_object (Google::Apis::PubsubV1beta2::SetIamPolicyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


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

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

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy detail is being requested. resource is usually specified as a path, such as, projects/project/zones/zone/ disks/disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective TestIamPermissions rpc.

  • test_iam_permissions_request_object (Google::Apis::PubsubV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


465
466
467
468
469
470
471
472
473
474
475
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 465

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

Parameters:

  • resource (String)

    REQUIRED: The resource for which policy detail is being requested. resource is usually specified as a path, such as, projects/project/zones/zone/ disks/disk``. The format for the path specified in this value is resource specific and is specified in the documentation for the respective TestIamPermissions rpc.

  • test_iam_permissions_request_object (Google::Apis::PubsubV1beta2::TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) (defaults to: nil)

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil)

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:


145
146
147
148
149
150
151
152
153
154
155
# File 'generated/google/apis/pubsub_v1beta2/service.rb', line 145

def test_topic_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