Class: Google::Cloud::PubSub::V1::Publisher::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/pubsub/v1/publisher/client.rb

Overview

Client for the Publisher service.

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

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#project_path, #subscription_path, #topic_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Publisher client object.

Examples

To create a new Publisher client with the default configuration:

client = ::Google::Cloud::PubSub::V1::Publisher::Client.new

To create a new Publisher client with a custom configuration:

client = ::Google::Cloud::PubSub::V1::Publisher::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Publisher client.

Yield Parameters:



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 187

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
  credentials ||= Credentials.default scope: @config.scope
  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

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Publisher Client class.

See Configuration for a description of the configuration fields.

Example

To modify the configuration for all Publisher clients:

::Google::Cloud::PubSub::V1::Publisher::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 58

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

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



162
163
164
165
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 162

def configure
  yield @config if block_given?
  @config
end

#create_topic(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Topic #create_topic(name: nil, labels: nil, message_storage_policy: nil, kms_key_name: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

Creates the given topic with the given name. See the resource name rules.

Overloads:

  • #create_topic(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

    Pass arguments to create_topic via a request object, either of type Topic or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #create_topic(name: nil, labels: nil, message_storage_policy: nil, kms_key_name: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

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

    Parameters:

    • name (::String) (defaults to: nil) —

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

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      See Creating and managing labels.

    • message_storage_policy (::Google::Cloud::PubSub::V1::MessageStoragePolicy, ::Hash) (defaults to: nil) —

      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.

    • kms_key_name (::String) (defaults to: nil) —

      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/*.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 267

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 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) ⇒ ::Google::Protobuf::Empty #delete_topic(topic: nil) ⇒ ::Google::Protobuf::Empty

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

Overloads:

  • #delete_topic(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_topic via a request object, either of type DeleteTopicRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #delete_topic(topic: nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

    • topic (::String) (defaults to: nil) —

      Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 772

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 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) ⇒ ::Google::Cloud::PubSub::V1::DetachSubscriptionResponse #detach_subscription(subscription: nil) ⇒ ::Google::Cloud::PubSub::V1::DetachSubscriptionResponse

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.

Overloads:

  • #detach_subscription(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::DetachSubscriptionResponse

    Pass arguments to detach_subscription via a request object, either of type DetachSubscriptionRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #detach_subscription(subscription: nil) ⇒ ::Google::Cloud::PubSub::V1::DetachSubscriptionResponse

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

    Parameters:

    • subscription (::String) (defaults to: nil) —

      Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 842

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 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) ⇒ ::Google::Cloud::PubSub::V1::Topic #get_topic(topic: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

Gets the configuration of a topic.

Overloads:

  • #get_topic(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

    Pass arguments to get_topic via a request object, either of type GetTopicRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #get_topic(topic: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

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

    Parameters:

    • topic (::String) (defaults to: nil) —

      Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 477

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 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) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse #list_topic_snapshots(topic: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse

Lists the names of the snapshots on this topic. Snapshots are used in Seek 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.

Overloads:

  • #list_topic_snapshots(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse

    Pass arguments to list_topic_snapshots via a request object, either of type ListTopicSnapshotsRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_topic_snapshots(topic: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse

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

    Parameters:

    • topic (::String) (defaults to: nil) —

      Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of snapshot names to return.

    • page_token (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 701

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 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) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse #list_topic_subscriptions(topic: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse

Lists the names of the attached subscriptions on this topic.

Overloads:

  • #list_topic_subscriptions(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse

    Pass arguments to list_topic_subscriptions via a request object, either of type ListTopicSubscriptionsRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_topic_subscriptions(topic: nil, page_size: nil, page_token: nil) ⇒ ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse

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

    Parameters:

    • topic (::String) (defaults to: nil) —

      Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of subscription names to return.

    • page_token (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 624

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 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) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic> #list_topics(project: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic>

Lists matching topics.

Overloads:

  • #list_topics(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic>

    Pass arguments to list_topics via a request object, either of type ListTopicsRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #list_topics(project: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::PubSub::V1::Topic>

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

    Parameters:

    • project (::String) (defaults to: nil) —

      Required. The name of the project in which to list topics. Format is projects/{project-id}.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of topics to return.

    • page_token (::String) (defaults to: nil) —

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

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 550

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 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) ⇒ ::Google::Cloud::PubSub::V1::PublishResponse #publish(topic: nil, messages: nil) ⇒ ::Google::Cloud::PubSub::V1::PublishResponse

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

Overloads:

  • #publish(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::PublishResponse

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

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #publish(topic: nil, messages: nil) ⇒ ::Google::Cloud::PubSub::V1::PublishResponse

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

    Parameters:

    • topic (::String) (defaults to: nil) —

      Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.

    • messages (::Array<::Google::Cloud::PubSub::V1::PubsubMessage, ::Hash>) (defaults to: nil) —

      Required. The messages to publish.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 410

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 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) ⇒ ::Google::Cloud::PubSub::V1::Topic #update_topic(topic: nil, update_mask: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

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

Overloads:

  • #update_topic(request, options = nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

    Pass arguments to update_topic via a request object, either of type UpdateTopicRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

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

  • #update_topic(topic: nil, update_mask: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

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

    Parameters:

    • topic (::Google::Cloud::PubSub::V1::Topic, ::Hash) (defaults to: nil) —

      Required. The updated topic object.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/pubsub/v1/publisher/client.rb', line 340

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