Class: Google::Cloud::PubSub::V1::TopicAdmin::Client

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

Overview

rubocop:disable Style/Documentation

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#crypto_key_path, #project_path, #schema_path, #subscription_path, #topic_path

Constructor Details

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

Create a new TopicAdmin client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the TopicAdmin client.

Yield Parameters:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 171

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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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

  @topic_admin_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::PubSub::V1::Publisher::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @topic_admin_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @topic_admin_stub.endpoint
    config.universe_domain = @topic_admin_stub.universe_domain
    config.logger = @topic_admin_stub.logger if config.respond_to? :logger=
  end
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

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


235
236
237
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 235

def iam_policy_client
  @iam_policy_client
end

Class Method Details

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

Configure the TopicAdmin Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 64

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: 4, 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

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

Configure the TopicAdmin Client class.

See Configuration for a description of the configuration fields.

Examples:

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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/helpers.rb', line 25

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: 4, 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 TopicAdmin 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:



141
142
143
144
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 141

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, schema_settings: nil, satisfies_pzs: nil, message_retention_duration: nil, ingestion_data_source_settings: nil, message_transforms: nil, tags: nil) ⇒ ::Google::Cloud::PubSub::V1::Topic

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

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::Topic.new

# Call the create_topic method.
result = client.create_topic request

# The returned object is of type Google::Cloud::PubSub::V1::Topic.
p result

Overloads:

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

    Pass arguments to create_topic via a request object, either of type Google::Cloud::PubSub::V1::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, schema_settings: nil, satisfies_pzs: nil, message_retention_duration: nil, ingestion_data_source_settings: nil, message_transforms: nil, tags: 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) —

      Optional. See Creating and managing labels.

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

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

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

    • schema_settings (::Google::Cloud::PubSub::V1::SchemaSettings, ::Hash) (defaults to: nil) —

      Optional. Settings for validating messages published against a schema.

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

      Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.

    • message_retention_duration (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      Optional. 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 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 31 days or less than 10 minutes.

    • ingestion_data_source_settings (::Google::Cloud::PubSub::V1::IngestionDataSourceSettings, ::Hash) (defaults to: nil) —

      Optional. Settings for ingestion from a data source into this topic.

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

      Optional. Transforms to be applied to messages published to the topic. Transforms are applied in the order specified.

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

      Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



335
336
337
338
339
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
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 335

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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

  @topic_admin_stub.call_rpc :create_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
  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_.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::DeleteTopicRequest.new

# Call the delete_topic method.
result = client.delete_topic request

# The returned object is of type Google::Protobuf::Empty.
p result

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.



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 978

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic
    header_params["topic"] = request.topic
  end

  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

  @topic_admin_stub.call_rpc :delete_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::DetachSubscriptionRequest.new

# Call the detach_subscription method.
result = client.detach_subscription request

# The returned object is of type Google::Cloud::PubSub::V1::DetachSubscriptionResponse.
p result

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.



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 1067

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.subscription
    header_params["subscription"] = request.subscription
  end

  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

  @topic_admin_stub.call_rpc :detach_subscription, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::GetTopicRequest.new

# Call the get_topic method.
result = client.get_topic request

# The returned object is of type Google::Cloud::PubSub::V1::Topic.
p result

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.



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 602

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic
    header_params["topic"] = request.topic
  end

  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

  @topic_admin_stub.call_rpc :get_topic, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::ListTopicSnapshotsRequest.new

# Call the list_topic_snapshots method.
result = client.list_topic_snapshots request

# The returned object is of type Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse.
p result

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

      Optional. Maximum number of snapshot names to return.

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

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



888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 888

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic
    header_params["topic"] = request.topic
  end

  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

  @topic_admin_stub.call_rpc :list_topic_snapshots, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::ListTopicSubscriptionsRequest.new

# Call the list_topic_subscriptions method.
result = client.list_topic_subscriptions request

# The returned object is of type Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse.
p result

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

      Optional. Maximum number of subscription names to return.

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

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



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 792

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic
    header_params["topic"] = request.topic
  end

  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

  @topic_admin_stub.call_rpc :list_topic_subscriptions, request, options: options do |response, operation|
    yield response, operation if block_given?
  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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::ListTopicsRequest.new

# Call the list_topics method.
result = client.list_topics request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::PubSub::V1::Topic.
  p item
end

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

      Optional. Maximum number of topics to return.

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

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



698
699
700
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
737
738
739
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 698

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.project
    header_params["project"] = request.project
  end

  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

  @topic_admin_stub.call_rpc :list_topics, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @topic_admin_stub, :list_topics, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


242
243
244
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 242

def logger
  @topic_admin_stub.logger
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.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::PublishRequest.new

# Call the publish method.
result = client.publish request

# The returned object is of type Google::Cloud::PubSub::V1::PublishResponse.
p result

Overloads:

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

    Pass arguments to publish via a request object, either of type 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.



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 516

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic
    header_params["topic"] = request.topic
  end

  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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


151
152
153
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 151

def universe_domain
  @topic_admin_stub.universe_domain
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 by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.

Examples:

Basic example

require "google/cloud/pubsub/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::PubSub::V1::TopicAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::PubSub::V1::UpdateTopicRequest.new

# Call the update_topic method.
result = client.update_topic request

# The returned object is of type Google::Cloud::PubSub::V1::Topic.
p result

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.



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/google/cloud/pubsub/v1/topic_admin/client.rb', line 427

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.topic&.name
    header_params["topic.name"] = request.topic.name
  end

  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

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