google-cloud-redis-v1 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5746ed4504526529823777fbccad2199504144c152759065b03c5eed67e5d2b7
-  data.tar.gz: cf56129a3503ac24c05b337593aa5fe7fecc302cd210471fc7306ec78830432b
+  metadata.gz: dc21799cc3ccfe42fa625d624a55bc180940d90f30c82704a8f93797ce8a7296
+  data.tar.gz: 1a992a6ea2e99abed7cfe722fdb0445c500ad4cc4c11e724a8c767d00bfa47d5
 SHA512:
-  metadata.gz: fe3a29b169c30453565bd402eec6c7734df371b7a0ec7bcd13d75ba30952b683443d50172385a8f41b0fc5d48508d98c00063015d4caa9ed819b349bf491609f
-  data.tar.gz: d2cfe978fd60e90f651b42238cdf0b6f3d4b034db39efd87c77815d5cc05b1c9d36fa95ba23dd9cb59510fadd9635ef12d158a673fa790a5825fec0961cb7104
+  metadata.gz: 8119448f084c29c6cd99d926f95cf72784a24ab0e51da805f42bc2ff97df6ea183c5615149a32fa1f2395ed6fc83bb2747ef9f8e3575b8168500487d6d1cf114
+  data.tar.gz: a4764f08683e83f65f31ed964307cd853cdc044448d0b2abf4ce32a2d0846b498bbfbcb4183fc0da5e4873f8fc91938ef6ca55d14fbe95739f3f9be5326d2d58

data/lib/google/cloud/redis/v1/cloud_redis/client.rb

@@ -187,7 +187,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -1441,6 +1442,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the CloudRedis API.
               #

data/lib/google/cloud/redis/v1/cloud_redis/operations.rb

@@ -93,7 +93,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
 
               # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the Operations API.
               #

data/lib/google/cloud/redis/v1/cloud_redis/rest/client.rb

@@ -248,6 +248,26 @@ module Google
               # @return [::Google::Cloud::Redis::V1::ListInstancesResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::ListInstancesRequest.new
+              #
+              #   # Call the list_instances method.
+              #   result = client.list_instances 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::Redis::V1::Instance.
+              #     p item
+              #   end
+              #
               def list_instances request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -312,6 +332,22 @@ module Google
               # @return [::Google::Cloud::Redis::V1::Instance]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::GetInstanceRequest.new
+              #
+              #   # Call the get_instance method.
+              #   result = client.get_instance request
+              #
+              #   # The returned object is of type Google::Cloud::Redis::V1::Instance.
+              #   p result
+              #
               def get_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -378,6 +414,22 @@ module Google
               # @return [::Google::Cloud::Redis::V1::InstanceAuthString]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::GetInstanceAuthStringRequest.new
+              #
+              #   # Call the get_instance_auth_string method.
+              #   result = client.get_instance_auth_string request
+              #
+              #   # The returned object is of type Google::Cloud::Redis::V1::InstanceAuthString.
+              #   p result
+              #
               def get_instance_auth_string request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -464,6 +516,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::CreateInstanceRequest.new
+              #
+              #   # Call the create_instance method.
+              #   result = client.create_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def create_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -542,6 +617,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::UpdateInstanceRequest.new
+              #
+              #   # Call the update_instance method.
+              #   result = client.update_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def update_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -610,6 +708,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::UpgradeInstanceRequest.new
+              #
+              #   # Call the upgrade_instance method.
+              #   result = client.upgrade_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def upgrade_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -684,6 +805,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::ImportInstanceRequest.new
+              #
+              #   # Call the import_instance method.
+              #   result = client.import_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def import_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -756,6 +900,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::ExportInstanceRequest.new
+              #
+              #   # Call the export_instance method.
+              #   result = client.export_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def export_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -825,6 +992,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::FailoverInstanceRequest.new
+              #
+              #   # Call the failover_instance method.
+              #   result = client.failover_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def failover_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -891,6 +1081,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::DeleteInstanceRequest.new
+              #
+              #   # Call the delete_instance method.
+              #   result = client.delete_instance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def delete_instance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -964,6 +1177,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/redis/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Redis::V1::CloudRedis::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Redis::V1::RescheduleMaintenanceRequest.new
+              #
+              #   # Call the reschedule_maintenance method.
+              #   result = client.reschedule_maintenance request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def reschedule_maintenance request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/redis/v1/cloud_redis/rest/operations.rb

@@ -136,6 +136,26 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::ListOperationsRequest.new
+              #
+              #   # Call the list_operations method.
+              #   result = client.list_operations 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::Longrunning::Operation.
+              #     p item
+              #   end
+              #
               def list_operations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -201,6 +221,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::GetOperationRequest.new
+              #
+              #   # Call the get_operation method.
+              #   result = client.get_operation request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use it to
+              #   # check the status of an operation, cancel it, or wait for results.
+              #   # Here is how to wait for a response.
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "No response received."
+              #   end
+              #
               def get_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -267,6 +310,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::DeleteOperationRequest.new
+              #
+              #   # Call the delete_operation method.
+              #   result = client.delete_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -338,6 +397,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/longrunning"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Longrunning::Operations::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Longrunning::CancelOperationRequest.new
+              #
+              #   # Call the cancel_operation method.
+              #   result = client.cancel_operation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def cancel_operation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/redis/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Redis
       module V1
-        VERSION = "0.11.1"
+        VERSION = "0.12.0"
       end
     end
   end

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-redis-v1
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Creates and manages Redis instances on the Google Cloud Platform.