Class: Google::Cloud::Pubsub::V1::SubscriberClient

Inherits:

Object

• Object
• Google::Cloud::Pubsub::V1::SubscriberClient

Defined in:

lib/google/cloud/pubsub/v1/subscriber_client.rb

Overview

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the +Pull+ method.

Constant Summary

SERVICE_ADDRESS =

The default address of the service.

"pubsub.googleapis.com".freeze

DEFAULT_SERVICE_PORT =

The default port of the service.

443

CODE_GEN_NAME_VERSION =

"gapic/0.1.0".freeze

DEFAULT_TIMEOUT =

30

ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/pubsub"
].freeze

Instance Attribute Summary

• #iam_policy_stub ⇒ Google::Iam::V1::IAMPolicy::Stub readonly
• #subscriber_stub ⇒ Google::Pubsub::V1::Subscriber::Stub readonly

Class Method Summary

• .match_project_from_project_name(project_name) ⇒ String

  Parses the project from a project resource.

• .match_project_from_subscription_name(subscription_name) ⇒ String

  Parses the project from a subscription resource.

• .match_project_from_topic_name(topic_name) ⇒ String

  Parses the project from a topic resource.

• .match_subscription_from_subscription_name(subscription_name) ⇒ String

  Parses the subscription from a subscription resource.

• .match_topic_from_topic_name(topic_name) ⇒ String

  Parses the topic from a topic resource.

• .project_path(project) ⇒ String

  Returns a fully-qualified project resource name string.

• .subscription_path(project, subscription) ⇒ String

  Returns a fully-qualified subscription resource name string.

• .topic_path(project, topic) ⇒ String

  Returns a fully-qualified topic resource name string.

Instance Method Summary

• #acknowledge(subscription, ack_ids, options: nil) ⇒ Object

  Acknowledges the messages associated with the +ack_ids+ in the +AcknowledgeRequest+.

• #create_subscription(name, topic, push_config: nil, ack_deadline_seconds: nil, options: nil) ⇒ Google::Pubsub::V1::Subscription

  Creates a subscription to a given topic.

• #delete_subscription(subscription, options: nil) ⇒ Object

  Deletes an existing subscription.

• #get_iam_policy(resource, options: nil) ⇒ Google::Iam::V1::Policy

  Gets the access control policy for a resource.

• #get_subscription(subscription, options: nil) ⇒ Google::Pubsub::V1::Subscription

  Gets the configuration details of a subscription.

• #initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: "gax", app_version: Google::Gax::VERSION) ⇒ SubscriberClient constructor

  A new instance of SubscriberClient.

• #list_subscriptions(project, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>

  Lists matching subscriptions.

• #modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds, options: nil) ⇒ Object

  Modifies the ack deadline for a specific message.

• #modify_push_config(subscription, push_config, options: nil) ⇒ Object

  Modifies the +PushConfig+ for a specified subscription.

• #pull(subscription, max_messages, return_immediately: nil, options: nil) ⇒ Google::Pubsub::V1::PullResponse

  Pulls messages from the server.

• #set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy

  Sets the access control policy on the specified resource.

• #streaming_pull(reqs, options: nil) ⇒ Enumerable<Google::Pubsub::V1::StreamingPullResponse>

  (EXPERIMENTAL) StreamingPull is an experimental feature.

• #test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

  Returns permissions that a caller has on the specified resource.

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: "gax", app_version: Google::Gax::VERSION) ⇒ SubscriberClient

Returns a new instance of SubscriberClient

Parameters:

• service_path (String) —

  The domain name of the API remote host.

• port (Integer) —

  The port on which to connect to the remote host.

• channel (Channel) —

  A Channel object through which to make calls.

• chan_creds (Grpc::ChannelCredentials) —

  A ChannelCredentials for the setting up the RPC client.

• client_config (Hash) —

  A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

• timeout (Numeric) —

  The default timeout, in seconds, for calls made through this client.

• app_name (String) —

  The codename of the calling service.

• app_version (String) —

  The version of the calling service.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 175

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: "gax",
    app_version: Google::Gax::VERSION
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/iam/v1/iam_policy_services_pb"
  require "google/pubsub/v1/pubsub_services_pb"


  google_api_client = "#{app_name}/#{app_version} " \
    "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
    "ruby/#{RUBY_VERSION}".freeze
  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "subscriber_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.pubsub.v1.Subscriber",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @iam_policy_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Iam::V1::IAMPolicy::Stub.method(:new)
  )
  @subscriber_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Pubsub::V1::Subscriber::Stub.method(:new)
  )

  @set_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:set_iam_policy),
    defaults["set_iam_policy"]
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @iam_policy_stub.method(:get_iam_policy),
    defaults["get_iam_policy"]
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @iam_policy_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"]
  )
  @create_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:create_subscription),
    defaults["create_subscription"]
  )
  @get_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:get_subscription),
    defaults["get_subscription"]
  )
  @list_subscriptions = Google::Gax.create_api_call(
    @subscriber_stub.method(:list_subscriptions),
    defaults["list_subscriptions"]
  )
  @delete_subscription = Google::Gax.create_api_call(
    @subscriber_stub.method(:delete_subscription),
    defaults["delete_subscription"]
  )
  @modify_ack_deadline = Google::Gax.create_api_call(
    @subscriber_stub.method(:modify_ack_deadline),
    defaults["modify_ack_deadline"]
  )
  @acknowledge = Google::Gax.create_api_call(
    @subscriber_stub.method(:acknowledge),
    defaults["acknowledge"]
  )
  @pull = Google::Gax.create_api_call(
    @subscriber_stub.method(:pull),
    defaults["pull"]
  )
  @streaming_pull = Google::Gax.create_api_call(
    @subscriber_stub.method(:streaming_pull),
    defaults["streaming_pull"]
  )
  @modify_push_config = Google::Gax.create_api_call(
    @subscriber_stub.method(:modify_push_config),
    defaults["modify_push_config"]
  )
end

Instance Attribute Details

#iam_policy_stub ⇒ Google::Iam::V1::IAMPolicy::Stub (readonly)

Returns:

• (Google::Iam::V1::IAMPolicy::Stub)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 43

class SubscriberClient
  attr_reader :iam_policy_stub, :subscriber_stub

  # The default address of the service.
  SERVICE_ADDRESS = "pubsub.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/pubsub"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SUBSCRIPTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/subscriptions/{subscription}"
  )

  private_constant :SUBSCRIPTION_PATH_TEMPLATE

  TOPIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/topics/{topic}"
  )

  private_constant :TOPIC_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified subscription resource name string.
  # @param project [String]
  # @param subscription [String]
  # @return [String]
  def self.subscription_path project, subscription
    SUBSCRIPTION_PATH_TEMPLATE.render(
      :"project" => project,
      :"subscription" => subscription
    )
  end

  # Returns a fully-qualified topic resource name string.
  # @param project [String]
  # @param topic [String]
  # @return [String]
  def self.topic_path project, topic
    TOPIC_PATH_TEMPLATE.render(
      :"project" => project,
      :"topic" => topic
    )
  end

  # Parses the project from a project resource.
  # @param project_name [String]
  # @return [String]
  def self.match_project_from_project_name project_name
    PROJECT_PATH_TEMPLATE.match(project_name)["project"]
  end

  # Parses the project from a subscription resource.
  # @param subscription_name [String]
  # @return [String]
  def self.match_project_from_subscription_name subscription_name
    SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["project"]
  end

  # Parses the subscription from a subscription resource.
  # @param subscription_name [String]
  # @return [String]
  def self.match_subscription_from_subscription_name subscription_name
    SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["subscription"]
  end

  # Parses the project from a topic resource.
  # @param topic_name [String]
  # @return [String]
  def self.match_project_from_topic_name topic_name
    TOPIC_PATH_TEMPLATE.match(topic_name)["project"]
  end

  # Parses the topic from a topic resource.
  # @param topic_name [String]
  # @return [String]
  def self.match_topic_from_topic_name topic_name
    TOPIC_PATH_TEMPLATE.match(topic_name)["topic"]
  end

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param client_config[Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param app_name [String]
  #   The codename of the calling service.
  # @param app_version [String]
  #   The version of the calling service.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: "gax",
      app_version: Google::Gax::VERSION
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/iam/v1/iam_policy_services_pb"
    require "google/pubsub/v1/pubsub_services_pb"


    google_api_client = "#{app_name}/#{app_version} " \
      "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
      "ruby/#{RUBY_VERSION}".freeze
    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "subscriber_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Subscriber",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @iam_policy_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Iam::V1::IAMPolicy::Stub.method(:new)
    )
    @subscriber_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Pubsub::V1::Subscriber::Stub.method(:new)
    )

    @set_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:set_iam_policy),
      defaults["set_iam_policy"]
    )
    @get_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:get_iam_policy),
      defaults["get_iam_policy"]
    )
    @test_iam_permissions = Google::Gax.create_api_call(
      @iam_policy_stub.method(:test_iam_permissions),
      defaults["test_iam_permissions"]
    )
    @create_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_subscription),
      defaults["create_subscription"]
    )
    @get_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:get_subscription),
      defaults["get_subscription"]
    )
    @list_subscriptions = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_subscriptions),
      defaults["list_subscriptions"]
    )
    @delete_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_subscription),
      defaults["delete_subscription"]
    )
    @modify_ack_deadline = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_ack_deadline),
      defaults["modify_ack_deadline"]
    )
    @acknowledge = Google::Gax.create_api_call(
      @subscriber_stub.method(:acknowledge),
      defaults["acknowledge"]
    )
    @pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:pull),
      defaults["pull"]
    )
    @streaming_pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:streaming_pull),
      defaults["streaming_pull"]
    )
    @modify_push_config = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_push_config),
      defaults["modify_push_config"]
    )
  end

  # Service calls

  # 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, conforming
  # to the
  # {resource name format}[https://cloud.google.com/pubsub/docs/overview#names].
  # The generated name is populated in the returned Subscription object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param 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"+.
  # @param topic [String]
  #   The name of the topic from which this subscription is receiving messages.
  #   Format is +projects/{project}/topics/{topic}+.
  #   The value of this field will be +_deleted-topic_+ if the topic has been
  #   deleted.
  # @param push_config [Google::Pubsub::V1::PushConfig]
  #   If push delivery is used with this subscription, this field is
  #   used to configure it. An empty +pushConfig+ signifies that the subscriber
  #   will pull and ack messages using API methods.
  # @param ack_deadline_seconds [Integer]
  #   This value is the maximum time after a subscriber receives a message
  #   before the subscriber should acknowledge the message. After message
  #   delivery but before the ack deadline expires and before the message is
  #   acknowledged, it is an outstanding message and will not be delivered
  #   again during that time (on a best-effort basis).
  #
  #   For pull subscriptions, this value is used as the initial value for the ack
  #   deadline. To override this value for a given message, call
  #   +ModifyAckDeadline+ with the corresponding +ack_id+ if using
  #   pull.
  #   The minimum custom deadline you can specify is 10 seconds.
  #   The maximum custom deadline you can specify is 600 seconds (10 minutes).
  #   If this parameter is 0, a default value of 10 seconds is used.
  #
  #   For push delivery, this value is also used to set the request timeout for
  #   the call to the push endpoint.
  #
  #   If the subscriber never acknowledges the message, the Pub/Sub
  #   system will eventually redeliver the message.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_name = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   formatted_topic = SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = subscriber_client.create_subscription(formatted_name, formatted_topic)

  def create_subscription \
      name,
      topic,
      push_config: nil,
      ack_deadline_seconds: nil,
      options: nil
    req = Google::Pubsub::V1::Subscription.new({
      name: name,
      topic: topic,
      push_config: push_config,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? })
    @create_subscription.call(req, options)
  end

  # Gets the configuration details of a subscription.
  #
  # @param subscription [String]
  #   The name of the subscription to get.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_subscription(formatted_subscription)

  def get_subscription \
      subscription,
      options: nil
    req = Google::Pubsub::V1::GetSubscriptionRequest.new({
      subscription: subscription
    }.delete_if { |_, v| v.nil? })
    @get_subscription.call(req, options)
  end

  # Lists matching subscriptions.
  #
  # @param project [String]
  #   The name of the cloud project that subscriptions belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>]
  #   An enumerable of Google::Pubsub::V1::Subscription instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_project = SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_subscriptions(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_subscriptions \
      project,
      page_size: nil,
      options: nil
    req = Google::Pubsub::V1::ListSubscriptionsRequest.new({
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? })
    @list_subscriptions.call(req, options)
  end

  # Deletes an existing subscription. All messages retained 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.
  #
  # @param subscription [String]
  #   The subscription to delete.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   subscriber_client.delete_subscription(formatted_subscription)

  def delete_subscription \
      subscription,
      options: nil
    req = Google::Pubsub::V1::DeleteSubscriptionRequest.new({
      subscription: subscription
    }.delete_if { |_, v| v.nil? })
    @delete_subscription.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   List of acknowledgment IDs.
  # @param ack_deadline_seconds [Integer]
  #   The new ack deadline with respect to the time this request was sent to
  #   the Pub/Sub system. For example, if the value is 10, the new
  #   ack deadline will expire 10 seconds after the +ModifyAckDeadline+ call
  #   was made. Specifying zero may immediately make the message available for
  #   another pull request.
  #   The minimum deadline you can specify is 0 seconds.
  #   The maximum deadline you can specify is 600 seconds (10 minutes).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   ack_deadline_seconds = 0
  #   subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

  def modify_ack_deadline \
      subscription,
      ack_ids,
      ack_deadline_seconds,
      options: nil
    req = Google::Pubsub::V1::ModifyAckDeadlineRequest.new({
      subscription: subscription,
      ack_ids: ack_ids,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? })
    @modify_ack_deadline.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The subscription whose message is being acknowledged.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   The acknowledgment ID for the messages being acknowledged that was returned
  #   by the Pub/Sub system in the +Pull+ response. Must not be empty.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   subscriber_client.acknowledge(formatted_subscription, ack_ids)

  def acknowledge \
      subscription,
      ack_ids,
      options: nil
    req = Google::Pubsub::V1::AcknowledgeRequest.new({
      subscription: subscription,
      ack_ids: ack_ids
    }.delete_if { |_, v| v.nil? })
    @acknowledge.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The subscription from which messages should be pulled.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param return_immediately [true, false]
  #   If this field set to true, the system will respond immediately even if
  #   it there are no messages available to return in the +Pull+ response.
  #   Otherwise, the system may wait (for a bounded amount of time) until at
  #   least one message is available, rather than returning no messages. The
  #   client may cancel the request if it does not wish to wait any longer for
  #   the response.
  # @param max_messages [Integer]
  #   The maximum number of messages returned for this request. The Pub/Sub
  #   system may return fewer than the number specified.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::PullResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   max_messages = 0
  #   response = subscriber_client.pull(formatted_subscription, max_messages)

  def pull \
      subscription,
      max_messages,
      return_immediately: nil,
      options: nil
    req = Google::Pubsub::V1::PullRequest.new({
      subscription: subscription,
      max_messages: max_messages,
      return_immediately: return_immediately
    }.delete_if { |_, v| v.nil? })
    @pull.call(req, options)
  end

  # (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will
  # respond with UNIMPLEMENTED errors unless you have been invited to test
  # this feature. Contact cloud-pubsub@google.com with any questions.
  #
  # Establishes a stream with the server, which sends messages down to the
  # client. The client streams acknowledgements and ack deadline modifications
  # back to the server. The server will close the stream and return the status
  # on any error. The server may close the stream with status +OK+ to reassign
  # server-side resources, in which case, the client should re-establish the
  # stream. +UNAVAILABLE+ may also be returned in the case of a transient error
  # (e.g., a server restart). These should also be retried by the client. Flow
  # control can be achieved by configuring the underlying RPC channel.
  #
  # @param reqs [Enumerable<Google::Pubsub::V1::StreamingPullRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Pubsub::V1::StreamingPullResponse>]
  #   An enumerable of Google::Pubsub::V1::StreamingPullResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   StreamingPullRequest = Google::Pubsub::V1::StreamingPullRequest
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   stream_ack_deadline_seconds = 0
  #   request = StreamingPullRequest.new
  #   request.subscription = formatted_subscription
  #   request.stream_ack_deadline_seconds = stream_ack_deadline_seconds
  #   requests = [request]
  #   subscriber_client.streaming_pull(requests).each do |element|
  #     # Process element.
  #   end

  def streaming_pull reqs, options: nil
    @streaming_pull.call(reqs, options)
  end

  # 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+.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param push_config [Google::Pubsub::V1::PushConfig]
  #   The push configuration for future deliveries.
  #
  #   An empty +pushConfig+ indicates that the Pub/Sub system should
  #   stop pushing messages from the given subscription and allow
  #   messages to be pulled and acknowledged - effectively pausing
  #   the subscription if +Pull+ is not called.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   PushConfig = Google::Pubsub::V1::PushConfig
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   push_config = PushConfig.new
  #   subscriber_client.modify_push_config(formatted_subscription, push_config)

  def modify_push_config \
      subscription,
      push_config,
      options: nil
    req = Google::Pubsub::V1::ModifyPushConfigRequest.new({
      subscription: subscription,
      push_config: push_config
    }.delete_if { |_, v| v.nil? })
    @modify_push_config.call(req, options)
    nil
  end

  # Sets the access control policy on the specified resource. Replaces any
  # existing policy.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being specified.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param policy [Google::Iam::V1::Policy]
  #   REQUIRED: The complete policy to be applied to the +resource+. The size of
  #   the policy is limited to a few 10s of KB. An empty policy is a
  #   valid policy but certain Cloud Platform services (such as Projects)
  #   might reject them.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   Policy = Google::Iam::V1::Policy
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   policy = Policy.new
  #   response = subscriber_client.set_iam_policy(formatted_resource, policy)

  def set_iam_policy \
      resource,
      policy,
      options: nil
    req = Google::Iam::V1::SetIamPolicyRequest.new({
      resource: resource,
      policy: policy
    }.delete_if { |_, v| v.nil? })
    @set_iam_policy.call(req, options)
  end

  # Gets the access control policy for a resource.
  # Returns an empty policy if the resource exists and does not have a policy
  # set.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_iam_policy(formatted_resource)

  def get_iam_policy \
      resource,
      options: nil
    req = Google::Iam::V1::GetIamPolicyRequest.new({
      resource: resource
    }.delete_if { |_, v| v.nil? })
    @get_iam_policy.call(req, options)
  end

  # Returns permissions that a caller has on the specified resource.
  # If the resource does not exist, this will return an empty set of
  # permissions, not a NOT_FOUND error.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy detail is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param permissions [Array<String>]
  #   The set of permissions to check for the +resource+. Permissions with
  #   wildcards (such as '*' or 'storage.*') are not allowed. For more
  #   information see
  #   {IAM Overview}[https://cloud.google.com/iam/docs/overview#permissions].
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   permissions = []
  #   response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

  def test_iam_permissions \
      resource,
      permissions,
      options: nil
    req = Google::Iam::V1::TestIamPermissionsRequest.new({
      resource: resource,
      permissions: permissions
    }.delete_if { |_, v| v.nil? })
    @test_iam_permissions.call(req, options)
  end
end

#subscriber_stub ⇒ Google::Pubsub::V1::Subscriber::Stub (readonly)

Returns:

• (Google::Pubsub::V1::Subscriber::Stub)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 43

class SubscriberClient
  attr_reader :iam_policy_stub, :subscriber_stub

  # The default address of the service.
  SERVICE_ADDRESS = "pubsub.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  CODE_GEN_NAME_VERSION = "gapic/0.1.0".freeze

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_subscriptions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "subscriptions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/pubsub"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  SUBSCRIPTION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/subscriptions/{subscription}"
  )

  private_constant :SUBSCRIPTION_PATH_TEMPLATE

  TOPIC_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/topics/{topic}"
  )

  private_constant :TOPIC_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified subscription resource name string.
  # @param project [String]
  # @param subscription [String]
  # @return [String]
  def self.subscription_path project, subscription
    SUBSCRIPTION_PATH_TEMPLATE.render(
      :"project" => project,
      :"subscription" => subscription
    )
  end

  # Returns a fully-qualified topic resource name string.
  # @param project [String]
  # @param topic [String]
  # @return [String]
  def self.topic_path project, topic
    TOPIC_PATH_TEMPLATE.render(
      :"project" => project,
      :"topic" => topic
    )
  end

  # Parses the project from a project resource.
  # @param project_name [String]
  # @return [String]
  def self.match_project_from_project_name project_name
    PROJECT_PATH_TEMPLATE.match(project_name)["project"]
  end

  # Parses the project from a subscription resource.
  # @param subscription_name [String]
  # @return [String]
  def self.match_project_from_subscription_name subscription_name
    SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["project"]
  end

  # Parses the subscription from a subscription resource.
  # @param subscription_name [String]
  # @return [String]
  def self.match_subscription_from_subscription_name subscription_name
    SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["subscription"]
  end

  # Parses the project from a topic resource.
  # @param topic_name [String]
  # @return [String]
  def self.match_project_from_topic_name topic_name
    TOPIC_PATH_TEMPLATE.match(topic_name)["project"]
  end

  # Parses the topic from a topic resource.
  # @param topic_name [String]
  # @return [String]
  def self.match_topic_from_topic_name topic_name
    TOPIC_PATH_TEMPLATE.match(topic_name)["topic"]
  end

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param client_config[Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param app_name [String]
  #   The codename of the calling service.
  # @param app_version [String]
  #   The version of the calling service.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: "gax",
      app_version: Google::Gax::VERSION
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/iam/v1/iam_policy_services_pb"
    require "google/pubsub/v1/pubsub_services_pb"


    google_api_client = "#{app_name}/#{app_version} " \
      "#{CODE_GEN_NAME_VERSION} gax/#{Google::Gax::VERSION} " \
      "ruby/#{RUBY_VERSION}".freeze
    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "subscriber_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.pubsub.v1.Subscriber",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @iam_policy_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Iam::V1::IAMPolicy::Stub.method(:new)
    )
    @subscriber_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Pubsub::V1::Subscriber::Stub.method(:new)
    )

    @set_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:set_iam_policy),
      defaults["set_iam_policy"]
    )
    @get_iam_policy = Google::Gax.create_api_call(
      @iam_policy_stub.method(:get_iam_policy),
      defaults["get_iam_policy"]
    )
    @test_iam_permissions = Google::Gax.create_api_call(
      @iam_policy_stub.method(:test_iam_permissions),
      defaults["test_iam_permissions"]
    )
    @create_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:create_subscription),
      defaults["create_subscription"]
    )
    @get_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:get_subscription),
      defaults["get_subscription"]
    )
    @list_subscriptions = Google::Gax.create_api_call(
      @subscriber_stub.method(:list_subscriptions),
      defaults["list_subscriptions"]
    )
    @delete_subscription = Google::Gax.create_api_call(
      @subscriber_stub.method(:delete_subscription),
      defaults["delete_subscription"]
    )
    @modify_ack_deadline = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_ack_deadline),
      defaults["modify_ack_deadline"]
    )
    @acknowledge = Google::Gax.create_api_call(
      @subscriber_stub.method(:acknowledge),
      defaults["acknowledge"]
    )
    @pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:pull),
      defaults["pull"]
    )
    @streaming_pull = Google::Gax.create_api_call(
      @subscriber_stub.method(:streaming_pull),
      defaults["streaming_pull"]
    )
    @modify_push_config = Google::Gax.create_api_call(
      @subscriber_stub.method(:modify_push_config),
      defaults["modify_push_config"]
    )
  end

  # Service calls

  # 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, conforming
  # to the
  # {resource name format}[https://cloud.google.com/pubsub/docs/overview#names].
  # The generated name is populated in the returned Subscription object.
  # Note that for REST API requests, you must specify a name in the request.
  #
  # @param 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"+.
  # @param topic [String]
  #   The name of the topic from which this subscription is receiving messages.
  #   Format is +projects/{project}/topics/{topic}+.
  #   The value of this field will be +_deleted-topic_+ if the topic has been
  #   deleted.
  # @param push_config [Google::Pubsub::V1::PushConfig]
  #   If push delivery is used with this subscription, this field is
  #   used to configure it. An empty +pushConfig+ signifies that the subscriber
  #   will pull and ack messages using API methods.
  # @param ack_deadline_seconds [Integer]
  #   This value is the maximum time after a subscriber receives a message
  #   before the subscriber should acknowledge the message. After message
  #   delivery but before the ack deadline expires and before the message is
  #   acknowledged, it is an outstanding message and will not be delivered
  #   again during that time (on a best-effort basis).
  #
  #   For pull subscriptions, this value is used as the initial value for the ack
  #   deadline. To override this value for a given message, call
  #   +ModifyAckDeadline+ with the corresponding +ack_id+ if using
  #   pull.
  #   The minimum custom deadline you can specify is 10 seconds.
  #   The maximum custom deadline you can specify is 600 seconds (10 minutes).
  #   If this parameter is 0, a default value of 10 seconds is used.
  #
  #   For push delivery, this value is also used to set the request timeout for
  #   the call to the push endpoint.
  #
  #   If the subscriber never acknowledges the message, the Pub/Sub
  #   system will eventually redeliver the message.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_name = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   formatted_topic = SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
  #   response = subscriber_client.create_subscription(formatted_name, formatted_topic)

  def create_subscription \
      name,
      topic,
      push_config: nil,
      ack_deadline_seconds: nil,
      options: nil
    req = Google::Pubsub::V1::Subscription.new({
      name: name,
      topic: topic,
      push_config: push_config,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? })
    @create_subscription.call(req, options)
  end

  # Gets the configuration details of a subscription.
  #
  # @param subscription [String]
  #   The name of the subscription to get.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::Subscription]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_subscription(formatted_subscription)

  def get_subscription \
      subscription,
      options: nil
    req = Google::Pubsub::V1::GetSubscriptionRequest.new({
      subscription: subscription
    }.delete_if { |_, v| v.nil? })
    @get_subscription.call(req, options)
  end

  # Lists matching subscriptions.
  #
  # @param project [String]
  #   The name of the cloud project that subscriptions belong to.
  #   Format is +projects/{project}+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>]
  #   An enumerable of Google::Pubsub::V1::Subscription instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_project = SubscriberClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   subscriber_client.list_subscriptions(formatted_project).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_subscriptions \
      project,
      page_size: nil,
      options: nil
    req = Google::Pubsub::V1::ListSubscriptionsRequest.new({
      project: project,
      page_size: page_size
    }.delete_if { |_, v| v.nil? })
    @list_subscriptions.call(req, options)
  end

  # Deletes an existing subscription. All messages retained 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.
  #
  # @param subscription [String]
  #   The subscription to delete.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   subscriber_client.delete_subscription(formatted_subscription)

  def delete_subscription \
      subscription,
      options: nil
    req = Google::Pubsub::V1::DeleteSubscriptionRequest.new({
      subscription: subscription
    }.delete_if { |_, v| v.nil? })
    @delete_subscription.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   List of acknowledgment IDs.
  # @param ack_deadline_seconds [Integer]
  #   The new ack deadline with respect to the time this request was sent to
  #   the Pub/Sub system. For example, if the value is 10, the new
  #   ack deadline will expire 10 seconds after the +ModifyAckDeadline+ call
  #   was made. Specifying zero may immediately make the message available for
  #   another pull request.
  #   The minimum deadline you can specify is 0 seconds.
  #   The maximum deadline you can specify is 600 seconds (10 minutes).
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   ack_deadline_seconds = 0
  #   subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

  def modify_ack_deadline \
      subscription,
      ack_ids,
      ack_deadline_seconds,
      options: nil
    req = Google::Pubsub::V1::ModifyAckDeadlineRequest.new({
      subscription: subscription,
      ack_ids: ack_ids,
      ack_deadline_seconds: ack_deadline_seconds
    }.delete_if { |_, v| v.nil? })
    @modify_ack_deadline.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The subscription whose message is being acknowledged.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param ack_ids [Array<String>]
  #   The acknowledgment ID for the messages being acknowledged that was returned
  #   by the Pub/Sub system in the +Pull+ response. Must not be empty.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   ack_ids = []
  #   subscriber_client.acknowledge(formatted_subscription, ack_ids)

  def acknowledge \
      subscription,
      ack_ids,
      options: nil
    req = Google::Pubsub::V1::AcknowledgeRequest.new({
      subscription: subscription,
      ack_ids: ack_ids
    }.delete_if { |_, v| v.nil? })
    @acknowledge.call(req, options)
    nil
  end

  # 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.
  #
  # @param subscription [String]
  #   The subscription from which messages should be pulled.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param return_immediately [true, false]
  #   If this field set to true, the system will respond immediately even if
  #   it there are no messages available to return in the +Pull+ response.
  #   Otherwise, the system may wait (for a bounded amount of time) until at
  #   least one message is available, rather than returning no messages. The
  #   client may cancel the request if it does not wish to wait any longer for
  #   the response.
  # @param max_messages [Integer]
  #   The maximum number of messages returned for this request. The Pub/Sub
  #   system may return fewer than the number specified.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Pubsub::V1::PullResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   max_messages = 0
  #   response = subscriber_client.pull(formatted_subscription, max_messages)

  def pull \
      subscription,
      max_messages,
      return_immediately: nil,
      options: nil
    req = Google::Pubsub::V1::PullRequest.new({
      subscription: subscription,
      max_messages: max_messages,
      return_immediately: return_immediately
    }.delete_if { |_, v| v.nil? })
    @pull.call(req, options)
  end

  # (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will
  # respond with UNIMPLEMENTED errors unless you have been invited to test
  # this feature. Contact cloud-pubsub@google.com with any questions.
  #
  # Establishes a stream with the server, which sends messages down to the
  # client. The client streams acknowledgements and ack deadline modifications
  # back to the server. The server will close the stream and return the status
  # on any error. The server may close the stream with status +OK+ to reassign
  # server-side resources, in which case, the client should re-establish the
  # stream. +UNAVAILABLE+ may also be returned in the case of a transient error
  # (e.g., a server restart). These should also be retried by the client. Flow
  # control can be achieved by configuring the underlying RPC channel.
  #
  # @param reqs [Enumerable<Google::Pubsub::V1::StreamingPullRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Pubsub::V1::StreamingPullResponse>]
  #   An enumerable of Google::Pubsub::V1::StreamingPullResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   StreamingPullRequest = Google::Pubsub::V1::StreamingPullRequest
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   stream_ack_deadline_seconds = 0
  #   request = StreamingPullRequest.new
  #   request.subscription = formatted_subscription
  #   request.stream_ack_deadline_seconds = stream_ack_deadline_seconds
  #   requests = [request]
  #   subscriber_client.streaming_pull(requests).each do |element|
  #     # Process element.
  #   end

  def streaming_pull reqs, options: nil
    @streaming_pull.call(reqs, options)
  end

  # 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+.
  #
  # @param subscription [String]
  #   The name of the subscription.
  #   Format is +projects/{project}/subscriptions/{sub}+.
  # @param push_config [Google::Pubsub::V1::PushConfig]
  #   The push configuration for future deliveries.
  #
  #   An empty +pushConfig+ indicates that the Pub/Sub system should
  #   stop pushing messages from the given subscription and allow
  #   messages to be pulled and acknowledged - effectively pausing
  #   the subscription if +Pull+ is not called.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   PushConfig = Google::Pubsub::V1::PushConfig
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   push_config = PushConfig.new
  #   subscriber_client.modify_push_config(formatted_subscription, push_config)

  def modify_push_config \
      subscription,
      push_config,
      options: nil
    req = Google::Pubsub::V1::ModifyPushConfigRequest.new({
      subscription: subscription,
      push_config: push_config
    }.delete_if { |_, v| v.nil? })
    @modify_push_config.call(req, options)
    nil
  end

  # Sets the access control policy on the specified resource. Replaces any
  # existing policy.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being specified.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param policy [Google::Iam::V1::Policy]
  #   REQUIRED: The complete policy to be applied to the +resource+. The size of
  #   the policy is limited to a few 10s of KB. An empty policy is a
  #   valid policy but certain Cloud Platform services (such as Projects)
  #   might reject them.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   Policy = Google::Iam::V1::Policy
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   policy = Policy.new
  #   response = subscriber_client.set_iam_policy(formatted_resource, policy)

  def set_iam_policy \
      resource,
      policy,
      options: nil
    req = Google::Iam::V1::SetIamPolicyRequest.new({
      resource: resource,
      policy: policy
    }.delete_if { |_, v| v.nil? })
    @set_iam_policy.call(req, options)
  end

  # Gets the access control policy for a resource.
  # Returns an empty policy if the resource exists and does not have a policy
  # set.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   response = subscriber_client.get_iam_policy(formatted_resource)

  def get_iam_policy \
      resource,
      options: nil
    req = Google::Iam::V1::GetIamPolicyRequest.new({
      resource: resource
    }.delete_if { |_, v| v.nil? })
    @get_iam_policy.call(req, options)
  end

  # Returns permissions that a caller has on the specified resource.
  # If the resource does not exist, this will return an empty set of
  # permissions, not a NOT_FOUND error.
  #
  # @param resource [String]
  #   REQUIRED: The resource for which the policy detail is being requested.
  #   +resource+ is usually specified as a path. For example, a Project
  #   resource is specified as +projects/{project}+.
  # @param permissions [Array<String>]
  #   The set of permissions to check for the +resource+. Permissions with
  #   wildcards (such as '*' or 'storage.*') are not allowed. For more
  #   information see
  #   {IAM Overview}[https://cloud.google.com/iam/docs/overview#permissions].
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/pubsub/v1/subscriber_client"
  #
  #   SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient
  #
  #   subscriber_client = SubscriberClient.new
  #   formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
  #   permissions = []
  #   response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

  def test_iam_permissions \
      resource,
      permissions,
      options: nil
    req = Google::Iam::V1::TestIamPermissionsRequest.new({
      resource: resource,
      permissions: permissions
    }.delete_if { |_, v| v.nil? })
    @test_iam_permissions.call(req, options)
  end
end

Class Method Details

.match_project_from_project_name(project_name) ⇒ String

Parses the project from a project resource.

Parameters:

• project_name (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 124

def self.match_project_from_project_name project_name
  PROJECT_PATH_TEMPLATE.match(project_name)["project"]
end

.match_project_from_subscription_name(subscription_name) ⇒ String

Parses the project from a subscription resource.

Parameters:

• subscription_name (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 131

def self.match_project_from_subscription_name subscription_name
  SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["project"]
end

.match_project_from_topic_name(topic_name) ⇒ String

Parses the project from a topic resource.

Parameters:

• topic_name (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 145

def self.match_project_from_topic_name topic_name
  TOPIC_PATH_TEMPLATE.match(topic_name)["project"]
end

.match_subscription_from_subscription_name(subscription_name) ⇒ String

Parses the subscription from a subscription resource.

Parameters:

• subscription_name (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 138

def self.match_subscription_from_subscription_name subscription_name
  SUBSCRIPTION_PATH_TEMPLATE.match(subscription_name)["subscription"]
end

.match_topic_from_topic_name(topic_name) ⇒ String

Parses the topic from a topic resource.

Parameters:

• topic_name (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 152

def self.match_topic_from_topic_name topic_name
  TOPIC_PATH_TEMPLATE.match(topic_name)["topic"]
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

• project (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 93

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

.subscription_path(project, subscription) ⇒ String

Returns a fully-qualified subscription resource name string.

Parameters:

• project (String)
• subscription (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 103

def self.subscription_path project, subscription
  SUBSCRIPTION_PATH_TEMPLATE.render(
    :"project" => project,
    :"subscription" => subscription
  )
end

.topic_path(project, topic) ⇒ String

Returns a fully-qualified topic resource name string.

Parameters:

• project (String)
• topic (String)

Returns:

• (String)

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 114

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

Instance Method Details

#acknowledge(subscription, ack_ids, options: nil) ⇒ Object

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.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
ack_ids = []
subscriber_client.acknowledge(formatted_subscription, ack_ids)

Parameters:

• subscription (String) —

  The subscription whose message is being acknowledged. Format is +projects/project/subscriptions/sub+.

• ack_ids (Array<String>) —

  The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the +Pull+ response. Must not be empty.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 546

def acknowledge \
    subscription,
    ack_ids,
    options: nil
  req = Google::Pubsub::V1::AcknowledgeRequest.new({
    subscription: subscription,
    ack_ids: ack_ids
  }.delete_if { |_, v| v.nil? })
  @acknowledge.call(req, options)
  nil
end

#create_subscription(name, topic, push_config: nil, ack_deadline_seconds: nil, options: nil) ⇒ Google::Pubsub::V1::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, conforming to the name format[https://cloud.google.com/pubsub/docs/overview#names]. The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_name = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
formatted_topic = SubscriberClient.topic_path("[PROJECT]", "[TOPIC]")
response = subscriber_client.create_subscription(formatted_name, formatted_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"+.

• topic (String) —

  The name of the topic from which this subscription is receiving messages. Format is +projects/project/topics/topic+. The value of this field will be +deleted-topic+ if the topic has been deleted.

• push_config (Google::Pubsub::V1::PushConfig) —

  If push delivery is used with this subscription, this field is used to configure it. An empty +pushConfig+ signifies that the subscriber will pull and ack messages using API methods.

• ack_deadline_seconds (Integer) —

  This value is the maximum time after a subscriber receives a message before the subscriber should acknowledge the message. After message delivery but before the ack deadline expires and before the message is acknowledged, it is an outstanding message and will not be delivered again during that time (on a best-effort basis).

  For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call +ModifyAckDeadline+ with the corresponding +ack_id+ if using pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used.

  For push delivery, this value is also used to set the request timeout for the call to the push endpoint.

  If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Pubsub::V1::Subscription)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 343

def create_subscription \
    name,
    topic,
    push_config: nil,
    ack_deadline_seconds: nil,
    options: nil
  req = Google::Pubsub::V1::Subscription.new({
    name: name,
    topic: topic,
    push_config: push_config,
    ack_deadline_seconds: ack_deadline_seconds
  }.delete_if { |_, v| v.nil? })
  @create_subscription.call(req, options)
end

#delete_subscription(subscription, options: nil) ⇒ Object

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

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
subscriber_client.delete_subscription(formatted_subscription)

Parameters:

• subscription (String) —

  The subscription to delete. Format is +projects/project/subscriptions/sub+.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 460

def delete_subscription \
    subscription,
    options: nil
  req = Google::Pubsub::V1::DeleteSubscriptionRequest.new({
    subscription: subscription
  }.delete_if { |_, v| v.nil? })
  @delete_subscription.call(req, options)
  nil
end

#get_iam_policy(resource, options: nil) ⇒ Google::Iam::V1::Policy

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

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.get_iam_policy(formatted_resource)

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Iam::V1::Policy)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 758

def get_iam_policy \
    resource,
    options: nil
  req = Google::Iam::V1::GetIamPolicyRequest.new({
    resource: resource
  }.delete_if { |_, v| v.nil? })
  @get_iam_policy.call(req, options)
end

#get_subscription(subscription, options: nil) ⇒ Google::Pubsub::V1::Subscription

Gets the configuration details of a subscription.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
response = subscriber_client.get_subscription(formatted_subscription)

Parameters:

• subscription (String) —

  The name of the subscription to get. Format is +projects/project/subscriptions/sub+.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Pubsub::V1::Subscription)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 377

def get_subscription \
    subscription,
    options: nil
  req = Google::Pubsub::V1::GetSubscriptionRequest.new({
    subscription: subscription
  }.delete_if { |_, v| v.nil? })
  @get_subscription.call(req, options)
end

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

Lists matching subscriptions.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_project = SubscriberClient.project_path("[PROJECT]")

# Iterate over all results.
subscriber_client.list_subscriptions(formatted_project).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
subscriber_client.list_subscriptions(formatted_project).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

• project (String) —

  The name of the cloud project that subscriptions belong to. Format is +projects/project+.

• page_size (Integer) —

  The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Gax::PagedEnumerable<Google::Pubsub::V1::Subscription>) —

  An enumerable of Google::Pubsub::V1::Subscription instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 427

def list_subscriptions \
    project,
    page_size: nil,
    options: nil
  req = Google::Pubsub::V1::ListSubscriptionsRequest.new({
    project: project,
    page_size: page_size
  }.delete_if { |_, v| v.nil? })
  @list_subscriptions.call(req, options)
end

#modify_ack_deadline(subscription, ack_ids, ack_deadline_seconds, options: nil) ⇒ Object

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.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
ack_ids = []
ack_deadline_seconds = 0
subscriber_client.modify_ack_deadline(formatted_subscription, ack_ids, ack_deadline_seconds)

Parameters:

• subscription (String) —

  The name of the subscription. Format is +projects/project/subscriptions/sub+.

• ack_ids (Array<String>) —

  List of acknowledgment IDs.

• ack_deadline_seconds (Integer) —

  The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the +ModifyAckDeadline+ call was made. Specifying zero may immediately make the message available for another pull request. The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes).

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 504

def modify_ack_deadline \
    subscription,
    ack_ids,
    ack_deadline_seconds,
    options: nil
  req = Google::Pubsub::V1::ModifyAckDeadlineRequest.new({
    subscription: subscription,
    ack_ids: ack_ids,
    ack_deadline_seconds: ack_deadline_seconds
  }.delete_if { |_, v| v.nil? })
  @modify_ack_deadline.call(req, options)
  nil
end

#modify_push_config(subscription, push_config, options: nil) ⇒ Object

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

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

PushConfig = Google::Pubsub::V1::PushConfig
SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
push_config = PushConfig.new
subscriber_client.modify_push_config(formatted_subscription, push_config)

Parameters:

• subscription (String) —

  The name of the subscription. Format is +projects/project/subscriptions/sub+.

• push_config (Google::Pubsub::V1::PushConfig) —

  The push configuration for future deliveries.

  An empty +pushConfig+ indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if +Pull+ is not called.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 685

def modify_push_config \
    subscription,
    push_config,
    options: nil
  req = Google::Pubsub::V1::ModifyPushConfigRequest.new({
    subscription: subscription,
    push_config: push_config
  }.delete_if { |_, v| v.nil? })
  @modify_push_config.call(req, options)
  nil
end

#pull(subscription, max_messages, return_immediately: nil, options: nil) ⇒ Google::Pubsub::V1::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.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
max_messages = 0
response = subscriber_client.pull(formatted_subscription, max_messages)

Parameters:

• subscription (String) —

  The subscription from which messages should be pulled. Format is +projects/project/subscriptions/sub+.

• return_immediately (true, false) —

  If this field set to true, the system will respond immediately even if it there are no messages available to return in the +Pull+ response. Otherwise, the system may wait (for a bounded amount of time) until at least one message is available, rather than returning no messages. The client may cancel the request if it does not wish to wait any longer for the response.

• max_messages (Integer) —

  The maximum number of messages returned for this request. The Pub/Sub system may return fewer than the number specified.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Pubsub::V1::PullResponse)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 591

def pull \
    subscription,
    max_messages,
    return_immediately: nil,
    options: nil
  req = Google::Pubsub::V1::PullRequest.new({
    subscription: subscription,
    max_messages: max_messages,
    return_immediately: return_immediately
  }.delete_if { |_, v| v.nil? })
  @pull.call(req, options)
end

#set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

Policy = Google::Iam::V1::Policy
SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
policy = Policy.new
response = subscriber_client.set_iam_policy(formatted_resource, policy)

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy is being specified. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

• policy (Google::Iam::V1::Policy) —

  REQUIRED: The complete policy to be applied to the +resource+. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Iam::V1::Policy)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 725

def set_iam_policy \
    resource,
    policy,
    options: nil
  req = Google::Iam::V1::SetIamPolicyRequest.new({
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? })
  @set_iam_policy.call(req, options)
end

#streaming_pull(reqs, options: nil) ⇒ Enumerable<Google::Pubsub::V1::StreamingPullResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

(EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status +OK+ to reassign server-side resources, in which case, the client should re-establish the stream. +UNAVAILABLE+ may also be returned in the case of a transient error (e.g., a server restart). These should also be retried by the client. Flow control can be achieved by configuring the underlying RPC channel.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

StreamingPullRequest = Google::Pubsub::V1::StreamingPullRequest
SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_subscription = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
stream_ack_deadline_seconds = 0
request = StreamingPullRequest.new
request.subscription = formatted_subscription
request.stream_ack_deadline_seconds = stream_ack_deadline_seconds
requests = [request]
subscriber_client.streaming_pull(requests).each do |element|
  # Process element.
end

Parameters:

• reqs (Enumerable<Google::Pubsub::V1::StreamingPullRequest>) —

  The input requests.

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Enumerable<Google::Pubsub::V1::StreamingPullResponse>) —

  An enumerable of Google::Pubsub::V1::StreamingPullResponse instances.

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 649

def streaming_pull reqs, options: nil
  @streaming_pull.call(reqs, options)
end

#test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Examples:

require "google/cloud/pubsub/v1/subscriber_client"

SubscriberClient = Google::Cloud::Pubsub::V1::SubscriberClient

subscriber_client = SubscriberClient.new
formatted_resource = SubscriberClient.subscription_path("[PROJECT]", "[SUBSCRIPTION]")
permissions = []
response = subscriber_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

• resource (String) —

  REQUIRED: The resource for which the policy detail is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/project+.

• permissions (Array<String>) —

  The set of permissions to check for the +resource+. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see Overview[https://cloud.google.com/iam/docs/overview#permissions].

• options (Google::Gax::CallOptions) —

  Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

• (Google::Iam::V1::TestIamPermissionsResponse)

Raises:

• (Google::Gax::GaxError) —

  if the RPC is aborted.

# File 'lib/google/cloud/pubsub/v1/subscriber_client.rb', line 795

def test_iam_permissions \
    resource,
    permissions,
    options: nil
  req = Google::Iam::V1::TestIamPermissionsRequest.new({
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? })
  @test_iam_permissions.call(req, options)
end