class Google::Cloud::PubSub::V1::Publisher::Client

Client for the Publisher service.

The service that an application uses to manipulate topics, and to send messages to a topic.

Attributes

publisher_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Publisher Client class.

See {::Google::Cloud::PubSub::V1::Publisher::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Publisher clients
::Google::Cloud::PubSub::V1::Publisher::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 57
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "PubSub", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_topic.timeout = 60.0
    default_config.rpcs.create_topic.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_topic.timeout = 60.0
    default_config.rpcs.update_topic.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.publish.timeout = 60.0
    default_config.rpcs.publish.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [10, 1, 13, 8, 2, 14, 4]
    }

    default_config.rpcs.get_topic.timeout = 60.0
    default_config.rpcs.get_topic.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
    }

    default_config.rpcs.list_topics.timeout = 60.0
    default_config.rpcs.list_topics.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
    }

    default_config.rpcs.list_topic_subscriptions.timeout = 60.0
    default_config.rpcs.list_topic_subscriptions.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
    }

    default_config.rpcs.list_topic_snapshots.timeout = 60.0
    default_config.rpcs.list_topic_snapshots.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [2, 10, 14]
    }

    default_config.rpcs.delete_topic.timeout = 60.0
    default_config.rpcs.delete_topic.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.detach_subscription.timeout = 60.0
    default_config.rpcs.detach_subscription.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Publisher client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::PubSub::V1::Publisher::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::PubSub::V1::Publisher::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Publisher client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 155
def initialize
  # 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 "gapic/grpc"
  require "google/pubsub/v1/pubsub_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @publisher_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PubSub::V1::Publisher::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the Publisher Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::PubSub::V1::Publisher::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 134
def configure
  yield @config if block_given?
  @config
end
create_topic(request, options = nil) { |response, operation| ... } click to toggle source

Creates the given topic with the given name. See the [resource name rules] (cloud.google.com/pubsub/docs/admin#resource_names).

@overload create_topic(request, options = nil)

Pass arguments to `create_topic` via a request object, either of type
{::Google::Cloud::PubSub::V1::Topic} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::Topic, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_topic(name: nil, labels: nil, message_storage_policy: nil, kms_key_name: nil, schema_settings: nil, satisfies_pzs: nil, message_retention_duration: nil)

Pass arguments to `create_topic` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param name [::String]
  Required. The name of the topic. It must have the format
  `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
  and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
  underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
  signs (`%`). It must be between 3 and 255 characters in length, and it
  must not start with `"goog"`.
@param labels [::Hash{::String => ::String}]
  See [Creating and managing labels]
  (https://cloud.google.com/pubsub/docs/labels).
@param message_storage_policy [::Google::Cloud::PubSub::V1::MessageStoragePolicy, ::Hash]
  Policy constraining the set of Google Cloud Platform regions where messages
  published to the topic may be stored. If not present, then no constraints
  are in effect.
@param kms_key_name [::String]
  The resource name of the Cloud KMS CryptoKey to be used to protect access
  to messages published on this topic.

  The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
@param schema_settings [::Google::Cloud::PubSub::V1::SchemaSettings, ::Hash]
  Settings for validating messages published against a schema.
@param satisfies_pzs [::Boolean]
  Reserved for future use. This field is set only in responses from the
  server; it is ignored if it is set in any requests.
@param message_retention_duration [::Google::Protobuf::Duration, ::Hash]
  Indicates the minimum duration to retain a message after it is published to
  the topic. If this field is set, messages published to the topic in the
  last `message_retention_duration` are always available to subscribers. For
  instance, it allows any attached subscription to [seek to a
  timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time)
  that is up to `message_retention_duration` in the past. If this field is
  not set, message retention is controlled by settings on individual
  subscriptions. Cannot be more than 7 days or less than 10 minutes.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::Topic] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::Topic]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 254
def create_topic request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::Topic

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_topic.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_topic.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_topic.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :create_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
delete_topic(request, options = nil) { |response, operation| ... } click to toggle source

Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `deleted-topic`.

@overload delete_topic(request, options = nil)

Pass arguments to `delete_topic` via a request object, either of type
{::Google::Cloud::PubSub::V1::DeleteTopicRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::DeleteTopicRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload delete_topic(topic: nil)

Pass arguments to `delete_topic` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::String]
  Required. Name of the topic to delete.
  Format is `projects/{project}/topics/{topic}`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Protobuf::Empty]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 773
def delete_topic request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::DeleteTopicRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_topic.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic" => request.topic
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_topic.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_topic.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :delete_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
detach_subscription(request, options = nil) { |response, operation| ... } click to toggle source

Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.

@overload detach_subscription(request, options = nil)

Pass arguments to `detach_subscription` via a request object, either of type
{::Google::Cloud::PubSub::V1::DetachSubscriptionRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::DetachSubscriptionRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload detach_subscription(subscription: nil)

Pass arguments to `detach_subscription` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param subscription [::String]
  Required. The subscription to detach.
  Format is `projects/{project}/subscriptions/{subscription}`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::DetachSubscriptionResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::DetachSubscriptionResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 845
def detach_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::DetachSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.detach_subscription.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "subscription" => request.subscription
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.detach_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.detach_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :detach_subscription, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_topic(request, options = nil) { |response, operation| ... } click to toggle source

Gets the configuration of a topic.

@overload get_topic(request, options = nil)

Pass arguments to `get_topic` via a request object, either of type
{::Google::Cloud::PubSub::V1::GetTopicRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::GetTopicRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_topic(topic: nil)

Pass arguments to `get_topic` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::String]
  Required. The name of the topic to get.
  Format is `projects/{project}/topics/{topic}`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::Topic] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::Topic]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 470
def get_topic request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::GetTopicRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_topic.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic" => request.topic
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_topic.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_topic.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :get_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_topic_snapshots(request, options = nil) { |response, operation| ... } click to toggle source

Lists the names of the snapshots on this topic. Snapshots are used in [Seek](cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

@overload list_topic_snapshots(request, options = nil)

Pass arguments to `list_topic_snapshots` via a request object, either of type
{::Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_topic_snapshots(topic: nil, page_size: nil, page_token: nil)

Pass arguments to `list_topic_snapshots` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::String]
  Required. The name of the topic that snapshots are attached to.
  Format is `projects/{project}/topics/{topic}`.
@param page_size [::Integer]
  Maximum number of snapshot names to return.
@param page_token [::String]
  The value returned by the last `ListTopicSnapshotsResponse`; indicates
  that this is a continuation of a prior `ListTopicSnapshots` call, and
  that the system should return the next page of data.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 700
def list_topic_snapshots request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_topic_snapshots.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic" => request.topic
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_topic_snapshots.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_topic_snapshots.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :list_topic_snapshots, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_topic_subscriptions(request, options = nil) { |response, operation| ... } click to toggle source

Lists the names of the attached subscriptions on this topic.

@overload list_topic_subscriptions(request, options = nil)

Pass arguments to `list_topic_subscriptions` via a request object, either of type
{::Google::Cloud::PubSub::V1::ListTopicSubscriptionsRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::ListTopicSubscriptionsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_topic_subscriptions(topic: nil, page_size: nil, page_token: nil)

Pass arguments to `list_topic_subscriptions` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::String]
  Required. The name of the topic that subscriptions are attached to.
  Format is `projects/{project}/topics/{topic}`.
@param page_size [::Integer]
  Maximum number of subscription names to return.
@param page_token [::String]
  The value returned by the last `ListTopicSubscriptionsResponse`; indicates
  that this is a continuation of a prior `ListTopicSubscriptions` call, and
  that the system should return the next page of data.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 621
def list_topic_subscriptions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_topic_subscriptions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic" => request.topic
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_topic_subscriptions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_topic_subscriptions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :list_topic_subscriptions, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_topics(request, options = nil) { |response, operation| ... } click to toggle source

Lists matching topics.

@overload list_topics(request, options = nil)

Pass arguments to `list_topics` via a request object, either of type
{::Google::Cloud::PubSub::V1::ListTopicsRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::ListTopicsRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_topics(project: nil, page_size: nil, page_token: nil)

Pass arguments to `list_topics` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param project [::String]
  Required. The name of the project in which to list topics.
  Format is `projects/{project-id}`.
@param page_size [::Integer]
  Maximum number of topics to return.
@param page_token [::String]
  The value returned by the last `ListTopicsResponse`; indicates that this is
  a continuation of a prior `ListTopics` call, and that the system should
  return the next page of data.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 545
def list_topics request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::ListTopicsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_topics.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "project" => request.project
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_topics.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_topics.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :list_topics, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @publisher_stub, :list_topics, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
publish(request, options = nil) { |response, operation| ... } click to toggle source

Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist.

@overload publish(request, options = nil)

Pass arguments to `publish` via a request object, either of type
{::Google::Cloud::PubSub::V1::PublishRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::PublishRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload publish(topic: nil, messages: nil)

Pass arguments to `publish` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::String]
  Required. The messages in the request will be published on this topic.
  Format is `projects/{project}/topics/{topic}`.
@param messages [::Array<::Google::Cloud::PubSub::V1::PubsubMessage, ::Hash>]
  Required. The messages to publish.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::PublishResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::PublishResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 401
def publish request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::PublishRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.publish.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic" => request.topic
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.publish.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.publish.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :publish, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
update_topic(request, options = nil) { |response, operation| ... } click to toggle source

Updates an existing topic. Note that certain properties of a topic are not modifiable.

@overload update_topic(request, options = nil)

Pass arguments to `update_topic` via a request object, either of type
{::Google::Cloud::PubSub::V1::UpdateTopicRequest} or an equivalent Hash.

@param request [::Google::Cloud::PubSub::V1::UpdateTopicRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload update_topic(topic: nil, update_mask: nil)

Pass arguments to `update_topic` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param topic [::Google::Cloud::PubSub::V1::Topic, ::Hash]
  Required. The updated topic object.
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  Required. Indicates which fields in the provided topic to update. Must be
  specified and non-empty. Note that if `update_mask` contains
  "message_storage_policy" but the `message_storage_policy` is not set in
  the `topic` provided above, then the updated value is determined by the
  policy configured at the project or organization level.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::PubSub::V1::Topic] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::PubSub::V1::Topic]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/pubsub/v1/publisher/client.rb, line 329
def update_topic request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::PubSub::V1::UpdateTopicRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_topic.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::PubSub::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "topic.name" => request.topic.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_topic.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_topic.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @publisher_stub.call_rpc :update_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end