Class: Gcloud::Pubsub::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/gcloud/pubsub/subscription.rb,
lib/gcloud/pubsub/subscription/list.rb

Overview

# Subscription

A named resource representing the stream of messages from a single, specific Topic, to be delivered to the subscribing application.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
msgs = sub.pull
msgs.each { |msg| msg.acknowledge! }

Defined Under Namespace

Classes: List

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Subscription

Returns a new instance of Subscription.



49
50
51
52
53
54
 
# File 'lib/gcloud/pubsub/subscription.rb', line 49

def initialize
  @service = nil
  @grpc = Google::Pubsub::V1::Subscription.new
  @name = nil
  @exists = nil
end

Instance Attribute Details

#grpc ⇒ Object 



45
46
47
 
# File 'lib/gcloud/pubsub/subscription.rb', line 45

def grpc
  @grpc
end

#service ⇒ Object 



41
42
43
 
# File 'lib/gcloud/pubsub/subscription.rb', line 41

def service
  @service
end

Class Method Details

.from_grpc(grpc, service) ⇒ Object

object.



534
535
536
537
538
539
 
# File 'lib/gcloud/pubsub/subscription.rb', line 534

def self.from_grpc grpc, service
  new.tap do |f|
    f.grpc = grpc
    f.service = service
  end
end

.new_lazy(name, service, options = {}) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/gcloud/pubsub/subscription.rb', line 58

def self.new_lazy name, service, options = {}
  sub = new.tap do |f|
    f.grpc = nil
    f.service = service
  end
  sub.instance_eval do
    @name = service.subscription_path(name, options)
  end
  sub
end

Instance Method Details

#acknowledge(*messages) ⇒ Object Also known as: ack

Acknowledges receipt of a message. After an ack, the Pub/Sub system can remove the message from the subscription. Acknowledging a message whose ack deadline has expired may succeed, although the message may have been sent again. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
messages = sub.pull
sub.acknowledge messages

Parameters:



357
358
359
360
361
362
363
364
365
 
# File 'lib/gcloud/pubsub/subscription.rb', line 357

def acknowledge *messages
  ack_ids = coerce_ack_ids messages
  return true if ack_ids.empty?
  ensure_service!
  service.acknowledge name, *ack_ids
  true
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#deadline ⇒ Object

This value is the maximum number of seconds after a subscriber receives a message before the subscriber should acknowledge the message.



97
98
99
100
 
# File 'lib/gcloud/pubsub/subscription.rb', line 97

def deadline
  ensure_grpc!
  @grpc.ack_deadline_seconds
end

#delay(new_deadline, *messages) ⇒ Object

Modifies the acknowledge deadline for messages.

This indicates that more time is needed to process the messages, or to make the messages available for redelivery if the processing was interrupted.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
messages = sub.pull
sub.delay 120, messages

Parameters:

  • new_deadline (Integer) —

    The new ack deadline in seconds from the time this request is sent to the Pub/Sub system. Must be >= 0. For example, if the value is ‘10`, the new ack deadline will expire 10 seconds after the call is made. Specifying `0` may immediately make the message available for another pull request.

  • messages (ReceivedMessage, String) —

    One or more ReceivedMessage objects or ack_id values.



393
394
395
396
397
398
399
400
 
# File 'lib/gcloud/pubsub/subscription.rb', line 393

def delay new_deadline, *messages
  ack_ids = coerce_ack_ids messages
  ensure_service!
  service.modify_ack_deadline name, ack_ids, new_deadline
  return true
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#delete ⇒ Boolean

Deletes an existing subscription. All pending messages in the subscription are immediately dropped.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.delete

Returns:

  • (Boolean) —

    Returns ‘true` if the subscription was deleted.



179
180
181
182
183
184
185
 
# File 'lib/gcloud/pubsub/subscription.rb', line 179

def delete
  ensure_service!
  service.delete_subscription name
  return true
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#endpoint ⇒ Object

Returns the URL locating the endpoint to which messages should be pushed.



105
106
107
108
 
# File 'lib/gcloud/pubsub/subscription.rb', line 105

def endpoint
  ensure_grpc!
  @grpc.push_config.push_endpoint if @grpc.push_config
end

#endpoint=(new_endpoint) ⇒ Object

Sets the URL locating the endpoint to which messages should be pushed.



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/gcloud/pubsub/subscription.rb', line 112

def endpoint= new_endpoint
  ensure_service!
  service.modify_push_config name, new_endpoint, {}
  @grpc.push_config = Google::Pubsub::V1::PushConfig.new(
    push_endpoint: new_endpoint,
    attributes: {}
  ) if @grpc
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#exists? ⇒ Boolean

Determines whether the subscription exists in the Pub/Sub service.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.exists? #=> true

Returns:

  • (Boolean) 


135
136
137
138
139
140
141
142
143
144
 
# File 'lib/gcloud/pubsub/subscription.rb', line 135

def exists?
  # Always true if we have a grpc object
  return true unless @grpc.nil?
  # If we have a value, return it
  return @exists unless @exists.nil?
  ensure_grpc!
  @exists = !@grpc.nil?
rescue Gcloud::NotFoundError
  @exists = false
end

#lazy? ⇒ Boolean

Determines whether the subscription object was created with an HTTP call.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.get_subscription "my-topic-sub"
sub.lazy? #=> false

Returns:

  • (Boolean) 


160
161
162
 
# File 'lib/gcloud/pubsub/subscription.rb', line 160

def lazy?
  @grpc.nil?
end

#listen(max: 100, autoack: false, delay: 1) {|msg| ... } ⇒ Object

Poll the backend for new messages. This runs a loop to ping the API, blocking indefinitely, yielding retrieved messages as they are received.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.listen do |msg|
  # process msg
end

Limit the number of messages pulled per batch with ‘max`:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.listen max: 20 do |msg|
  # process msg
end

Automatically acknowledge messages with ‘autoack`:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.listen autoack: true do |msg|
  # process msg
end

Parameters:

  • max (Integer) (defaults to: 100) —

    The maximum number of messages to return for this request. The Pub/Sub system may return fewer than the number specified. The default value is ‘100`, the maximum value is `1000`.

  • autoack (Boolean) (defaults to: false) —

    Automatically acknowledge the message as it is pulled. The default value is ‘false`.

  • delay (Number) (defaults to: 1) —

    The number of seconds to pause between requests when the Google Cloud service has no messages to return. The default value is ‘1`.

Yields:

  • (msg) —

    a block for processing new messages

Yield Parameters:



325
326
327
328
329
330
331
332
333
334
 
# File 'lib/gcloud/pubsub/subscription.rb', line 325

def listen max: 100, autoack: false, delay: 1
  loop do
    msgs = wait_for_messages max: max, autoack: autoack
    if msgs.any?
      msgs.each { |msg| yield msg }
    else
      sleep delay
    end
  end
end

#name ⇒ Object

The name of the subscription.



71
72
73
 
# File 'lib/gcloud/pubsub/subscription.rb', line 71

def name
  @grpc ? @grpc.name : @name
end

#policy(force: nil) ⇒ Hash

Gets the access control policy.

By default, the policy values are memoized to reduce the number of API calls to the Pub/Sub service.

Examples:

Policy values are memoized to reduce the number of API calls:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

subscription = pubsub.subscription "my-subscription"
puts subscription.policy["bindings"]
puts subscription.policy["rules"]

Use ‘force` to retrieve the latest policy from the service:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

subscription = pubsub.subscription "my-subscription"
policy = subscription.policy force: true

Parameters:

  • force (Boolean) (defaults to: nil) —

    Force the latest policy to be retrieved from the Pub/Sub service when ‘true`. Otherwise the policy will be memoized to reduce the number of API calls made to the Pub/Sub service. The default is `false`.

Returns:

  • (Hash) —

    Returns a hash that conforms to the following structure:

    {

    "etag"=>"CAE=",
"bindings" => [{
  "role" => "roles/viewer",
  "members" => ["serviceAccount:your-service-account"]
}]

    }



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/gcloud/pubsub/subscription.rb', line 442

def policy force: nil
  @policy = nil if force
  @policy ||= begin
    ensure_service!
    grpc = service.get_subscription_policy name
    JSON.parse(Google::Iam::V1::Policy.encode_json(grpc))
  rescue GRPC::BadStatus => e
    raise Error.from_error(e)
  end
end

#policy=(new_policy) ⇒ Object

Sets the access control policy.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

viewer_policy = {
  "bindings" => [{
    "role" => "roles/viewer",
    "members" => ["serviceAccount:your-service-account"]
  }]
}
subscription = pubsub.subscription "my-subscription"
subscription.policy = viewer_policy

Parameters:

  • new_policy (String) —

    A hash that conforms to the following structure:

    {
  "bindings" => [{
    "role" => "roles/viewer",
    "members" => ["serviceAccount:your-service-account"]
  }]
}



481
482
483
484
485
486
487
 
# File 'lib/gcloud/pubsub/subscription.rb', line 481

def policy= new_policy
  ensure_service!
  grpc = service.set_subscription_policy name, new_policy
  @policy = JSON.parse(Google::Iam::V1::Policy.encode_json(grpc))
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#pull(immediate: true, max: 100, autoack: false) ⇒ Array<Gcloud::Pubsub::ReceivedMessage>

Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. Raises an ApiError with status ‘UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.pull.each { |msg| msg.acknowledge! }

A maximum number of messages returned can also be specified:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub", max: 10
sub.pull.each { |msg| msg.acknowledge! }

The call can block until messages are available:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
msgs = sub.pull immediate: false
msgs.each { |msg| msg.acknowledge! }

Parameters:

  • immediate (Boolean) (defaults to: true) —

    When ‘true` the system will respond immediately even if it is not able to return messages. When `false` the system is allowed to wait until it can return least one message. No messages are returned when a request times out. The default value is `true`.

  • max (Integer) (defaults to: 100) —

    The maximum number of messages to return for this request. The Pub/Sub system may return fewer than the number specified. The default value is ‘100`, the maximum value is `1000`.

  • autoack (Boolean) (defaults to: false) —

    Automatically acknowledge the message as it is pulled. The default value is ‘false`.

Returns:



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/gcloud/pubsub/subscription.rb', line 234

def pull immediate: true, max: 100, autoack: false
  ensure_service!
  options = { immediate: immediate, max: max }
  list_grpc = service.pull name, options
  messages = Array(list_grpc.received_messages).map do |msg_grpc|
    ReceivedMessage.from_grpc msg_grpc, self
  end
  acknowledge messages if autoack
  messages
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
rescue Faraday::TimeoutError
  []
end

#test_permissions(*permissions) ⇒ Array<String>

Tests the specified permissions against the [Cloud IAM](cloud.google.com/iam/) access control policy.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
sub = pubsub.subscription "my-subscription"
perms = sub.test_permissions "pubsub.subscriptions.get",
                             "pubsub.subscriptions.consume"
perms.include? "pubsub.subscriptions.get" #=> true
perms.include? "pubsub.subscriptions.consume" #=> false

Parameters:

  • permissions (String, Array<String>) —

    The set of permissions to check access for. Permissions with wildcards (such as ‘*` or `storage.*`) are not allowed.

    The permissions that can be checked on a subscription are:

    • pubsub.subscriptions.consume

    • pubsub.subscriptions.get

    • pubsub.subscriptions.delete

    • pubsub.subscriptions.update

    • pubsub.subscriptions.getIamPolicy

    • pubsub.subscriptions.setIamPolicy

Returns:

  • (Array<String>) —

    The permissions that have access.

See Also:



522
523
524
525
526
527
528
529
 
# File 'lib/gcloud/pubsub/subscription.rb', line 522

def test_permissions *permissions
  permissions = Array(permissions).flatten
  ensure_service!
  grpc = service.test_subscription_permissions name, permissions
  grpc.permissions
rescue GRPC::BadStatus => e
  raise Error.from_error(e)
end

#topic ⇒ Topic

The Topic from which this subscription receives messages.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
sub.topic.name #=> "projects/my-project/topics/my-topic"

Returns:



89
90
91
92
 
# File 'lib/gcloud/pubsub/subscription.rb', line 89

def topic
  ensure_grpc!
  Topic.new_lazy @grpc.topic, service
end

#wait_for_messages(max: 100, autoack: false) ⇒ Array<Gcloud::Pubsub::ReceivedMessage>

Pulls from the server while waiting for messages to become available. This is the same as:

subscription.pull immediate: false

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscription "my-topic-sub"
msgs = sub.wait_for_messages
msgs.each { |msg| msg.acknowledge! }

Parameters:

  • max (Integer) (defaults to: 100) —

    The maximum number of messages to return for this request. The Pub/Sub system may return fewer than the number specified. The default value is ‘100`, the maximum value is `1000`.

  • autoack (Boolean) (defaults to: false) —

    Automatically acknowledge the message as it is pulled. The default value is ‘false`.

Returns:



273
274
275
 
# File 'lib/gcloud/pubsub/subscription.rb', line 273

def wait_for_messages max: 100, autoack: false
  pull immediate: false, max: max, autoack: autoack
end