google-cloud-redis-v1 0.2.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc32c9b717c9f3a2386e7a391f6c129495a3351c7c2c06903ddf4f0105c53da
-  data.tar.gz: bf4c411d578b4d7a9feb9cf99df2035cfc3a834c4a327abb15756d86ab29132a
+  metadata.gz: 29559a3d56e02c4a4b025c1267ea36d7c8b945a514cb6ce51a030d83a81b8665
+  data.tar.gz: 4cf03c262f3e977ab438801478cf017a9f506c55f2b48d1988952f90938d44d0
 SHA512:
-  metadata.gz: 666a14e25d2a1746bb72856c3b2e4d8753146d281259b3ae01ba098c4508a610c60f3c94f5eb1b0d3279daf0448794ccf28433ae7d84960797d8740143c31a08
-  data.tar.gz: 16d002bf57633949400c9bac276ab277e80680e5965b86fe6d463a5859b4ff11ad50d8b082baa65b1c8186a9fbaaa963f34ca0ddc796b6d1afee7a62aa95e173
+  metadata.gz: e5f89ac203c08b214859e24d7ee6071f9529d5ea9d24bc94d2aaeb186781f617905ab1e8b8031b49f1903645317769c9ed419b76fb9c783c226c4d67a318ccf5
+  data.tar.gz: f3b50a7f8319d4f388ef0a73879920986f616be6aed2dfed4980a812907c206de19b3ec984207b9dc03a6dd9659ee074b44eb352d04fb34e40ae93e8eeb812e2

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

@@ -33,3 +33,6 @@ module Google
     end
   end
 end
+
+helper_path = ::File.join __dir__, "v1", "_helpers.rb"
+require "google/cloud/redis/v1/_helpers" if ::File.file? helper_path

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
@@ -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.
             #
@@ -896,7 +970,7 @@ module Google
 
               config_attr :endpoint,      "redis.googleapis.com", ::String
               config_attr :credentials,   nil do |value|
-                allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
@@ -936,7 +1010,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:
@@ -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

@@ -475,7 +475,7 @@ module Google
 
               config_attr :endpoint,      "redis.googleapis.com", ::String
               config_attr :credentials,   nil do |value|
-                allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                 allowed.any? { |klass| klass === value }
               end
@@ -515,7 +515,7 @@ module Google
               # Each configuration object is of type `Gapic::Config::Method` and includes
               # the following configuration fields:
               #
-              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
               #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
               #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
               #     include the following keys:

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,9 +56,9 @@ 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
@@ -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.2"
+        VERSION = "0.3.3"
       end
     end
   end

data/proto_docs/google/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -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.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2021-01-19 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
@@ -199,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Cloud Memorystore for Redis V1 API