Class: Gcloud::Pubsub::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/gcloud/pubsub/project.rb

Overview

Project

Represents the project that pubsub messages are pushed to and pulled from. Topic is a named resource to which messages are sent by publishers. Subscription is a named resource representing the stream of messages from a single, specific topic, to be delivered to the subscribing application. Message is a combination of data and attributes that a publisher sends to a topic and is eventually delivered to subscribers.

See Gcloud#pubsub

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topic = pubsub.topic "my-topic"
topic.publish "task completed"

Instance Method Summary collapse

Instance Method Details

#create_topic(topic_name) ⇒ Gcloud::Pubsub::Topic Also known as: new_topic

Creates a new topic.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.create_topic "my-topic"

Parameters:

  • topic_name (String)

    Name of a topic.

Returns:


168
169
170
171
172
173
174
175
176
# File 'lib/gcloud/pubsub/project.rb', line 168

def create_topic topic_name
  ensure_connection!
  resp = connection.create_topic topic_name
  if resp.success?
    Topic.from_gapi resp.data, connection
  else
    fail ApiError.from_response(resp)
  end
end

#projectObject

The Pub/Sub project connected to.

Examples:

require "gcloud"

gcloud = Gcloud.new "my-todo-project",
                    "/path/to/keyfile.json"
pubsub = gcloud.pubsub

pubsub.project #=> "my-todo-project"

69
70
71
# File 'lib/gcloud/pubsub/project.rb', line 69

def project
  connection.project
end

#publish(topic_name, data = nil, attributes = {}) {|batch| ... } ⇒ Message+

Publishes one or more messages to the given topic. The topic will be created if the topic does previously not exist and the autocreate option is provided.

A note about auto-creating the topic: Any message published to a topic without a subscription will be lost.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

msg = pubsub.publish "my-topic", "new-message"

Additionally, a message can be published with attributes:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

msg = pubsub.publish "my-topic", "new-message", foo: :bar,
                                                this: :that

Multiple messages can be sent at the same time using a block:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

msgs = pubsub.publish "my-topic" do |batch|
  batch.publish "new-message-1", foo: :bar
  batch.publish "new-message-2", foo: :baz
  batch.publish "new-message-3", foo: :bif
end

With autocreate:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

msg = pubsub.publish "new-topic", "new-message", autocreate: true

Parameters:

  • topic_name (String)

    Name of a topic.

  • data (String) (defaults to: nil)

    The message data.

  • attributes (Hash) (defaults to: {})

    Optional attributes for the message.

Options Hash (attributes):

  • :autocreate (Boolean)

    Flag to control whether the provided topic will be created if it does not exist.

Yields:

  • (batch)

Returns:

  • (Message, Array<Message>)

    Returns the published message when called without a block, or an array of messages when called with a block.


287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/gcloud/pubsub/project.rb', line 287

def publish topic_name, data = nil, attributes = {}
  # Fix parameters
  if data.is_a?(::Hash) && attributes.empty?
    attributes = data
    data = nil
  end
  # extract autocreate option
  autocreate = attributes.delete :autocreate
  ensure_connection!
  batch = Topic::Batch.new data, attributes
  yield batch if block_given?
  return nil if batch.messages.count.zero?
  publish_batch_messages topic_name, batch, autocreate
end

#subscribe(topic_name, subscription_name, deadline: nil, endpoint: nil, autocreate: nil) ⇒ Gcloud::Pubsub::Subscription Also known as: create_subscription, new_subscription

Creates a new Subscription object for the provided topic. The topic will be created if the topic does previously not exist and the autocreate option is provided.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscribe "my-topic", "my-topic-sub"
puts sub.name # => "my-topic-sub"

The name is optional, and will be generated if not given.

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscribe "my-topic"
puts sub.name # => "generated-sub-name"

Wait 2 minutes for acknowledgement and push all to an endpoint:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscribe "my-topic", "my-topic-sub",
                       deadline: 120,
                       endpoint: "https://example.com/push"

With autocreate:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

sub = pubsub.subscribe "new-topic", "new-topic-sub", autocreate: true

Parameters:

  • topic_name (String)

    Name of a topic.

  • subscription_name (String)

    Name of the new 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".

  • deadline (Integer)

    The maximum number of seconds after a subscriber receives a message before the subscriber should acknowledge the message.

  • endpoint (String)

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

  • autocreate (String)

    Flag to control whether the topic will be created if it does not exist.

Returns:


359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
# File 'lib/gcloud/pubsub/project.rb', line 359

def subscribe topic_name, subscription_name, deadline: nil, endpoint: nil,
              autocreate: nil
  ensure_connection!
  options = { deadline: deadline, endpoint: endpoint }
  resp = connection.create_subscription topic_name,
                                        subscription_name, options
  return Subscription.from_gapi(resp.data, connection) if resp.success?
  if autocreate && resp.status == 404
    create_topic topic_name
    return subscribe(topic_name, subscription_name,
                     deadline: deadline, endpoint: endpoint,
                     autocreate: false)
  end
  fail ApiError.from_response(resp)
end

#subscription(subscription_name, project: nil, skip_lookup: nil) ⇒ Gcloud::Pubsub::Subscription? Also known as: get_subscription, find_subscription

Retrieves subscription by name.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

subscription = pubsub.subscription "my-sub"
puts subscription.name

Skip the lookup against the service with skip_lookup:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

# No API call is made to retrieve the subscription information.
subscription = pubsub.subscription "my-sub", skip_lookup: true
puts subscription.name

Parameters:

  • subscription_name (String)

    Name of a subscription.

  • project (String)

    If the subscription belongs to a project other than the one currently connected to, the alternate project ID can be specified here.

  • skip_lookup (Boolean)

    Optionally create a Subscription object without verifying the subscription resource exists on the Pub/Sub service. Calls made on this object will raise errors if the service resource does not exist. Default is false.

Returns:


411
412
413
414
415
416
417
418
419
420
421
# File 'lib/gcloud/pubsub/project.rb', line 411

def subscription subscription_name, project: nil, skip_lookup: nil
  ensure_connection!
  options = { project: project }
  if skip_lookup
    return Subscription.new_lazy(subscription_name, connection, options)
  end
  resp = connection.get_subscription subscription_name
  return Subscription.from_gapi(resp.data, connection) if resp.success?
  return nil if resp.status == 404
  fail ApiError.from_response(resp)
end

#subscriptions(prefix: nil, token: nil, max: nil) ⇒ Array<Gcloud::Pubsub::Subscription> Also known as: find_subscriptions, list_subscriptions

Retrieves a list of subscriptions for the given project.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

subscriptions = pubsub.subscriptions
subscriptions.each do |subscription|
  puts subscription.name
end

With pagination: (See Subscription::List#token)


require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

all_subs = []
tmp_subs = pubsub.subscriptions
while tmp_subs.any? do
  tmp_subs.each do |subscription|
    all_subs << subscription
  end
  # break loop if no more subscriptions available
  break if tmp_subs.token.nil?
  # get the next group of subscriptions
  tmp_subs = pubsub.subscriptions token: tmp_subs.token
end

Parameters:

  • prefix (String)

    Filter results to subscriptions whose names begin with this prefix.

  • token (String)

    A previously-returned page token representing part of the larger set of results to view.

  • max (Integer)

    Maximum number of subscriptions to return.

Returns:


467
468
469
470
471
472
473
474
475
476
# File 'lib/gcloud/pubsub/project.rb', line 467

def subscriptions prefix: nil, token: nil, max: nil
  ensure_connection!
  options = { prefix: prefix, token: token, max: max }
  resp = connection.list_subscriptions options
  if resp.success?
    Subscription::List.from_response resp, connection
  else
    fail ApiError.from_response(resp)
  end
end

#topic(topic_name, autocreate: nil, project: nil, skip_lookup: nil) ⇒ Gcloud::Pubsub::Topic? Also known as: get_topic, find_topic

Retrieves topic by name.

The topic will be created if the topic does not exist and the autocreate option is set to true.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "existing-topic"

By default nil will be returned if the topic does not exist.

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "non-existing-topic" #=> nil

With the autocreate option set to true.

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "non-existing-topic", autocreate: true

Create a topic in a different project with the project flag.

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "another-topic", project: "another-project"

Skip the lookup against the service with skip_lookup:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub
topic = pubsub.topic "another-topic", skip_lookup: true

Parameters:

  • topic_name (String)

    Name of a topic.

  • autocreate (Boolean)

    Flag to control whether the requested topic will be created if it does not exist. Ignored if skip_lookup is true. The default value is false.

  • project (String)

    If the topic belongs to a project other than the one currently connected to, the alternate project ID can be specified here.

  • skip_lookup (Boolean)

    Optionally create a Topic object without verifying the topic resource exists on the Pub/Sub service. Calls made on this object will raise errors if the topic resource does not exist. Default is false.

Returns:

  • (Gcloud::Pubsub::Topic, nil)

    Returns nil if topic does not exist. Will return a newly created{ Gcloud::Pubsub::Topic} if the topic does not exist and autocreate is set to true.


139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/gcloud/pubsub/project.rb', line 139

def topic topic_name, autocreate: nil, project: nil, skip_lookup: nil
  ensure_connection!
  options = { project: project }
  return Topic.new_lazy(topic_name, connection, options) if skip_lookup
  resp = connection.get_topic topic_name
  return Topic.from_gapi(resp.data, connection) if resp.success?
  if resp.status == 404
    return create_topic(topic_name) if autocreate
    return nil
  end
  fail ApiError.from_response(resp)
end

#topics(token: nil, max: nil) ⇒ Array<Gcloud::Pubsub::Topic> Also known as: find_topics, list_topics

Retrieves a list of topics for the given project.

Examples:

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

topics = pubsub.topics
topics.each do |topic|
  puts topic.name
end

With pagination: (See Topic::List#token)

require "gcloud"

gcloud = Gcloud.new
pubsub = gcloud.pubsub

all_topics = []
tmp_topics = pubsub.topics
while tmp_topics.any? do
  tmp_topics.each do |topic|
    all_topics << topic
  end
  # break loop if no more topics available
  break if tmp_topics.token.nil?
  # get the next group of topics
  tmp_topics = pubsub.topics token: tmp_topics.token
end

Parameters:

  • token (String)

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

  • max (Integer)

    Maximum number of topics to return.

Returns:


219
220
221
222
223
224
225
226
227
228
# File 'lib/gcloud/pubsub/project.rb', line 219

def topics token: nil, max: nil
  ensure_connection!
  options = { token: token, max: max }
  resp = connection.list_topics options
  if resp.success?
    Topic::List.from_response resp, connection
  else
    fail ApiError.from_response(resp)
  end
end