lib/google/cloud/redis/v1/cloud_redis/client.rb in google-cloud-redis-v1-0.5.2 vs lib/google/cloud/redis/v1/cloud_redis/client.rb in google-cloud-redis-v1-0.5.3

- old
+ new

@@ -53,18 +53,17 @@ # Configure the CloudRedis Client class. # # See {::Google::Cloud::Redis::V1::CloudRedis::Client::Configuration} # for a description of the configuration fields. # - # ## Example + # @example # - # To modify the configuration for all CloudRedis clients: + # # Modify the configuration for all CloudRedis clients + # ::Google::Cloud::Redis::V1::CloudRedis::Client.configure do |config| + # config.timeout = 10.0 + # end # - # ::Google::Cloud::Redis::V1::CloudRedis::Client.configure do |config| - # config.timeout = 10.0 - # end - # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # @@ -124,24 +123,20 @@ end ## # Create a new CloudRedis client object. # - # ## Examples + # @example # - # To create a new CloudRedis client with the default - # configuration: + # # Create a client using the default configuration + # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new # - # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new + # # Create a client using a custom configuration + # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new do |config| + # config.timeout = 10.0 + # end # - # To create a new CloudRedis client with a custom - # configuration: - # - # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new do |config| - # config.timeout = 10.0 - # end - # # @yield [config] Configure the CloudRedis client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize @@ -156,14 +151,13 @@ # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials - # Use self-signed JWT if the scope and endpoint are unchanged from default, + # 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.scope == Client.configure.scope && - @config.endpoint == Client.configure.endpoint && + enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope @@ -268,11 +262,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_instances.timeout, metadata: metadata, retry_policy: @config.rpcs.list_instances.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :list_instances, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @cloud_redis_stub, :list_instances, request, response, operation, options yield response, operation if block_given? @@ -337,11 +333,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.get_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :get_instance, request, options: options do |response, operation| yield response, operation if block_given? return response @@ -427,11 +425,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.create_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :create_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -508,11 +508,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.update_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :update_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -580,11 +582,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.upgrade_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.upgrade_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :upgrade_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -658,11 +662,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.import_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.import_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :import_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -734,11 +740,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.export_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.export_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :export_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -807,11 +815,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.failover_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.failover_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :failover_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -877,11 +887,13 @@ metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_instance.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_instance.retry_policy - options.apply_defaults metadata: @config.metadata, + + options.apply_defaults timeout: @config.timeout, + metadata: @config.metadata, retry_policy: @config.retry_policy @cloud_redis_stub.call_rpc :delete_instance, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? @@ -902,25 +914,24 @@ # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # - # # Examples + # @example # - # To modify the global config, setting the timeout for list_instances - # to 20 seconds, and all remaining timeouts to 10 seconds: + # # Modify the global config, setting the timeout for + # # list_instances to 20 seconds, + # # and all remaining timeouts to 10 seconds. + # ::Google::Cloud::Redis::V1::CloudRedis::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.list_instances.timeout = 20.0 + # end # - # ::Google::Cloud::Redis::V1::CloudRedis::Client.configure do |config| - # config.timeout = 10.0 - # config.rpcs.list_instances.timeout = 20.0 - # end - # - # To apply the above configuration only to a new client: - # - # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new do |config| - # config.timeout = 10.0 - # config.rpcs.list_instances.timeout = 20.0 - # end + # # Apply the above configuration only to a new client. + # client = ::Google::Cloud::Redis::V1::CloudRedis::Client.new do |config| + # config.timeout = 10.0 + # config.rpcs.list_instances.timeout = 20.0 + # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"redis.googleapis.com"`. # @return [::String]