google-cloud-redis-v1 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db09d5d687a7c7e04b954ba99e87b4e7d972952f839e40ad2ae56aff7cec00c
-  data.tar.gz: fa4386a70ebb090d042d09671272d92ee5301e24059e33b7cbf73ae925d0ed4c
+  metadata.gz: ca8eb543d548c116f322adab922ba46b308bc76b7614d5234e8b7df65e144e86
+  data.tar.gz: 3d391f59e85102bb34c1a8bed0785eb2a70f77a80384fc5a31872e2fb10039cf
 SHA512:
-  metadata.gz: a573d10381e38beb34ab80f56080cd25e2495b58d5f66bf8c7bae49a14f16b21d103b60a7bd31f93c12368133c81c3edf967b3b7823e48c39229a3098c845844
-  data.tar.gz: 4518434cf6a34832a3ede77af09e35116aa2ad474f3705e977910e0ea79888ddefb1f6d3653812084ae9f7633894850b05c125c2e84384af7ca438ba61c2e531
+  metadata.gz: 7d834dd9cb72f7e256a9e358ecfd2a8e7b9aa3df4a024bf7b238ac45c6a7996dc1819b952578454722d8cfa7f2ae08a653456d6836ddadafb42afd06b8afe5d6
+  data.tar.gz: d0f432aad2978b86e85524fafcbb2939276c1f29c5c24a7c178b56560df7ff2ef89f75a3f1339381e69d8d094a1a438ad725607e2492b8036b846924be3ab1ce

data/README.md

@@ -18,6 +18,7 @@ In order to use this library, you first need to go through the following steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/redis.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
 ## Quick Start
@@ -33,6 +34,9 @@ response = client.list_instances request
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-redis-v1/latest)
 for class and method documentation.
 
+See also the [Product Documentation](https://cloud.google.com/memorystore/docs/redis)
+for general usage information.
+
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.

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

@@ -87,6 +87,8 @@ module Google
 
                 default_config.rpcs.update_instance.timeout = 600.0
 
+                default_config.rpcs.upgrade_instance.timeout = 600.0
+
                 default_config.rpcs.import_instance.timeout = 600.0
 
                 default_config.rpcs.export_instance.timeout = 600.0
@@ -346,7 +348,7 @@ module Google
             # Creates a Redis instance based on the specified tier and memory size.
             #
             # By default, the instance is accessible from the project's
-            # [default network](/compute/docs/networks-and-firewalls#networks).
+            # [default network](https://cloud.google.com/vpc/docs/vpc).
             #
             # The creation is executed asynchronously and callers may check the returned
             # operation to track its progress. Once the operation is completed the Redis
@@ -514,6 +516,78 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Upgrades Redis instance to the newer Redis version specified in the
+            # request.
+            #
+            # @overload upgrade_instance(request, options = nil)
+            #   Pass arguments to `upgrade_instance` via a request object, either of type
+            #   {::Google::Cloud::Redis::V1::UpgradeInstanceRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Redis::V1::UpgradeInstanceRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload upgrade_instance(name: nil, redis_version: nil)
+            #   Pass arguments to `upgrade_instance` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param name [::String]
+            #     Required. Redis instance resource name using the form:
+            #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
+            #     where `location_id` refers to a GCP region.
+            #   @param redis_version [::String]
+            #     Required. Specifies the target version of Redis software to upgrade to.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def upgrade_instance request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Redis::V1::UpgradeInstanceRequest
+
+              # 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.upgrade_instance.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::Redis::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.upgrade_instance.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.upgrade_instance.retry_policy
+              options.apply_defaults 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?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
             #
@@ -924,7 +998,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end
@@ -968,6 +1042,11 @@ module Google
                 #
                 attr_reader :update_instance
                 ##
+                # RPC-specific configuration for `upgrade_instance`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :upgrade_instance
+                ##
                 # RPC-specific configuration for `import_instance`
                 # @return [::Gapic::Config::Method]
                 #
@@ -998,6 +1077,8 @@ module Google
                   @create_instance = ::Gapic::Config::Method.new create_instance_config
                   update_instance_config = parent_rpcs&.update_instance if parent_rpcs&.respond_to? :update_instance
                   @update_instance = ::Gapic::Config::Method.new update_instance_config
+                  upgrade_instance_config = parent_rpcs&.upgrade_instance if parent_rpcs&.respond_to? :upgrade_instance
+                  @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
                   import_instance_config = parent_rpcs&.import_instance if parent_rpcs&.respond_to? :import_instance
                   @import_instance = ::Gapic::Config::Method.new import_instance_config
                   export_instance_config = parent_rpcs&.export_instance if parent_rpcs&.respond_to? :export_instance

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

@@ -85,6 +85,8 @@ module Google
               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
 
               @operations_stub = ::Gapic::ServiceStub.new(
                 ::Google::Longrunning::Operations::Stub,
@@ -501,7 +503,7 @@ module Google
               def rpcs
                 @rpcs ||= begin
                   parent_rpcs = nil
-                  parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
                   Rpcs.new parent_rpcs
                 end
               end

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

@@ -76,6 +76,10 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :update_mask, :message, 1, "google.protobuf.FieldMask"
       optional :instance, :message, 2, "google.cloud.redis.v1.Instance"
     end
+    add_message "google.cloud.redis.v1.UpgradeInstanceRequest" do
+      optional :name, :string, 1
+      optional :redis_version, :string, 2
+    end
     add_message "google.cloud.redis.v1.DeleteInstanceRequest" do
       optional :name, :string, 1
     end
@@ -142,6 +146,7 @@ module Google
         GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.GetInstanceRequest").msgclass
         CreateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.CreateInstanceRequest").msgclass
         UpdateInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.UpdateInstanceRequest").msgclass
+        UpgradeInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.UpgradeInstanceRequest").msgclass
         DeleteInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.DeleteInstanceRequest").msgclass
         GcsSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.GcsSource").msgclass
         InputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1.InputConfig").msgclass

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

@@ -56,13 +56,13 @@ module Google
             #
             # If `location_id` is specified as `-` (wildcard), then all regions
             # available to the project are queried, and the results are aggregated.
-            rpc :ListInstances, ListInstancesRequest, ListInstancesResponse
+            rpc :ListInstances, Google::Cloud::Redis::V1::ListInstancesRequest, Google::Cloud::Redis::V1::ListInstancesResponse
             # Gets the details of a specific Redis instance.
-            rpc :GetInstance, GetInstanceRequest, Instance
+            rpc :GetInstance, Google::Cloud::Redis::V1::GetInstanceRequest, Google::Cloud::Redis::V1::Instance
             # Creates a Redis instance based on the specified tier and memory size.
             #
             # By default, the instance is accessible from the project's
-            # [default network](/compute/docs/networks-and-firewalls#networks).
+            # [default network](https://cloud.google.com/vpc/docs/vpc).
             #
             # The creation is executed asynchronously and callers may check the returned
             # operation to track its progress. Once the operation is completed the Redis
@@ -71,13 +71,16 @@ module Google
             #
             # The returned operation is automatically deleted after a few hours, so there
             # is no need to call DeleteOperation.
-            rpc :CreateInstance, CreateInstanceRequest, Google::Longrunning::Operation
+            rpc :CreateInstance, Google::Cloud::Redis::V1::CreateInstanceRequest, Google::Longrunning::Operation
             # Updates the metadata and configuration of a specific Redis instance.
             #
             # Completed longrunning.Operation will contain the new instance object
             # in the response field. The returned operation is automatically deleted
             # after a few hours, so there is no need to call DeleteOperation.
-            rpc :UpdateInstance, UpdateInstanceRequest, Google::Longrunning::Operation
+            rpc :UpdateInstance, Google::Cloud::Redis::V1::UpdateInstanceRequest, Google::Longrunning::Operation
+            # Upgrades Redis instance to the newer Redis version specified in the
+            # request.
+            rpc :UpgradeInstance, Google::Cloud::Redis::V1::UpgradeInstanceRequest, Google::Longrunning::Operation
             # Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
             #
             # Redis may stop serving during this operation. Instance state will be
@@ -86,20 +89,20 @@ module Google
             #
             # The returned operation is automatically deleted after a few hours, so
             # there is no need to call DeleteOperation.
-            rpc :ImportInstance, ImportInstanceRequest, Google::Longrunning::Operation
+            rpc :ImportInstance, Google::Cloud::Redis::V1::ImportInstanceRequest, Google::Longrunning::Operation
             # Export Redis instance data into a Redis RDB format file in Cloud Storage.
             #
             # Redis will continue serving during this operation.
             #
             # The returned operation is automatically deleted after a few hours, so
             # there is no need to call DeleteOperation.
-            rpc :ExportInstance, ExportInstanceRequest, Google::Longrunning::Operation
+            rpc :ExportInstance, Google::Cloud::Redis::V1::ExportInstanceRequest, Google::Longrunning::Operation
             # Initiates a failover of the master node to current replica node for a
             # specific STANDARD tier Cloud Memorystore for Redis instance.
-            rpc :FailoverInstance, FailoverInstanceRequest, Google::Longrunning::Operation
+            rpc :FailoverInstance, Google::Cloud::Redis::V1::FailoverInstanceRequest, Google::Longrunning::Operation
             # Deletes a specific Redis instance.  Instance stops serving and data is
             # deleted.
-            rpc :DeleteInstance, DeleteInstanceRequest, Google::Longrunning::Operation
+            rpc :DeleteInstance, Google::Cloud::Redis::V1::DeleteInstanceRequest, Google::Longrunning::Operation
           end
 
           Stub = Service.rpc_stub_class

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Redis
       module V1
-        VERSION = "0.2.0"
+        VERSION = "0.3.1"
       end
     end
   end

data/proto_docs/google/cloud/redis/v1/cloud_redis.rb

@@ -121,7 +121,7 @@ module Google
         # @!attribute [rw] authorized_network
         #   @return [::String]
         #     Optional. The full name of the Google Compute Engine
-        #     [network](/compute/docs/networks-and-firewalls#networks) to which the
+        #     [network](https://cloud.google.com/vpc/docs/vpc) to which the
         #     instance is connected. If left unspecified, the `default` network
         #     will be used.
         # @!attribute [r] persistence_iam_identity
@@ -133,9 +133,8 @@ module Google
         #     operation.
         # @!attribute [rw] connect_mode
         #   @return [::Google::Cloud::Redis::V1::Instance::ConnectMode]
-        #     Optional. The connect mode of Redis instance.
-        #     If not provided, default one will be used.
-        #     Current default: DIRECT_PEERING.
+        #     Optional. The network connect mode of the Redis instance.
+        #     If not provided, the connect mode defaults to DIRECT_PEERING.
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -207,11 +206,12 @@ module Google
             # Not set.
             CONNECT_MODE_UNSPECIFIED = 0
 
-            # Connect via directly peering with memorystore redis hosted service.
+            # Connect via direct peering to the Memorystore for Redis hosted service.
             DIRECT_PEERING = 1
 
-            # Connect with google via private service access and share connection
-            # across google managed services.
+            # Connect your Memorystore for Redis instance using Private Service
+            # Access. Private services access provides an IP address range for multiple
+            # Google Cloud services, including Memorystore.
             PRIVATE_SERVICE_ACCESS = 2
           end
         end
@@ -320,6 +320,20 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Redis instance resource name using the form:
+        #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
+        #     where `location_id` refers to a GCP region.
+        # @!attribute [rw] redis_version
+        #   @return [::String]
+        #     Required. Specifies the target version of Redis software to upgrade to.
+        class UpgradeInstanceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request for {::Google::Cloud::Redis::V1::CloudRedis::Client#delete_instance DeleteInstance}.
         # @!attribute [rw] name
         #   @return [::String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-redis-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -161,7 +161,6 @@ files:
 - LICENSE.md
 - README.md
 - lib/google-cloud-redis-v1.rb
-- lib/google/cloud/common_resources_pb.rb
 - lib/google/cloud/redis/v1.rb
 - lib/google/cloud/redis/v1/cloud_redis.rb
 - lib/google/cloud/redis/v1/cloud_redis/client.rb
@@ -200,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Cloud Memorystore for Redis V1 API

data/lib/google/cloud/common_resources_pb.rb

@@ -1,15 +0,0 @@
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: google/cloud/common_resources.proto
-
-require 'google/protobuf'
-
-require 'google/api/resource_pb'
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("google/cloud/common_resources.proto", :syntax => :proto3) do
-  end
-end
-
-module Google
-  module Cloud
-  end
-end