google-cloud-redis 0.2.3 → 0.3.0

data/lib/google/cloud/redis/v1beta1/cloud_redis_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -88,28 +88,17 @@ module Google
             self::GRPC_INTERCEPTORS = CloudRedisClient::GRPC_INTERCEPTORS
           end
 
-          LOCATION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/locations/{location}"
-          )
-
-          private_constant :LOCATION_PATH_TEMPLATE
-
           INSTANCE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/locations/{location}/instances/{instance}"
           )
 
           private_constant :INSTANCE_PATH_TEMPLATE
 
-          # Returns a fully-qualified location resource name string.
-          # @param project [String]
-          # @param location [String]
-          # @return [String]
-          def self.location_path project, location
-            LOCATION_PATH_TEMPLATE.render(
-              :"project" => project,
-              :"location" => location
-            )
-          end
+          LOCATION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/locations/{location}"
+          )
+
+          private_constant :LOCATION_PATH_TEMPLATE
 
           # Returns a fully-qualified instance resource name string.
           # @param project [String]
@@ -124,6 +113,17 @@ module Google
             )
           end
 
+          # Returns a fully-qualified location resource name string.
+          # @param project [String]
+          # @param location [String]
+          # @return [String]
+          def self.location_path project, location
+            LOCATION_PATH_TEMPLATE.render(
+              :"project" => project,
+              :"location" => location
+            )
+          end
+
           # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
           #   Provides the means for authenticating requests made by the client. This parameter can
           #   be many types.
@@ -239,27 +239,50 @@ module Google
             @list_instances = Google::Gax.create_api_call(
               @cloud_redis_stub.method(:list_instances),
               defaults["list_instances"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @get_instance = Google::Gax.create_api_call(
               @cloud_redis_stub.method(:get_instance),
               defaults["get_instance"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @create_instance = Google::Gax.create_api_call(
               @cloud_redis_stub.method(:create_instance),
               defaults["create_instance"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @update_instance = Google::Gax.create_api_call(
               @cloud_redis_stub.method(:update_instance),
               defaults["update_instance"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'instance.name' => request.instance.name}
+              end
             )
             @delete_instance = Google::Gax.create_api_call(
               @cloud_redis_stub.method(:delete_instance),
               defaults["delete_instance"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
+            )
+            @failover_instance = Google::Gax.create_api_call(
+              @cloud_redis_stub.method(:failover_instance),
+              defaults["failover_instance"],
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
           end
 
@@ -362,7 +385,7 @@ module Google
 
           # Creates a Redis instance based on the specified tier and memory size.
           #
-          # By default, the instance is peered to the project's
+          # By default, the instance is accessible from the project's
           # [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks).
           #
           # The creation is executed asynchronously and callers may check the returned
@@ -463,11 +486,12 @@ module Google
           # @param update_mask [Google::Protobuf::FieldMask | Hash]
           #   Required. Mask of fields to update. At least one path must be supplied in
           #   this field. The elements of the repeated paths field may only include these
-          #   fields from {CloudRedis::Instance Instance}:
-          #   * `display_name`
-          #   * `labels`
-          #   * `memory_size_gb`
-          #   * `redis_config`
+          #   fields from {Google::Cloud::Redis::V1beta1::Instance Instance}:
+          #
+          #   * `displayName`
+          #     * `labels`
+          #   * `memorySizeGb`
+          #     * `redisConfig`
           #   A hash of the same form as `Google::Protobuf::FieldMask`
           #   can also be provided.
           # @param instance [Google::Cloud::Redis::V1beta1::Instance | Hash]
@@ -601,6 +625,77 @@ module Google
             operation.on_done { |operation| yield(operation) } if block_given?
             operation
           end
+
+          # Failover the master role to current replica node against a specific
+          # STANDARD tier redis instance.
+          #
+          # @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 data_protection_mode [Google::Cloud::Redis::V1beta1::FailoverInstanceRequest::DataProtectionMode]
+          #   Optional. Available data protection modes that the user can choose. If it's
+          #   unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
+          # @param options [Google::Gax::CallOptions]
+          #   Overrides the default settings for this call, e.g, timeout,
+          #   retries, etc.
+          # @return [Google::Gax::Operation]
+          # @raise [Google::Gax::GaxError] if the RPC is aborted.
+          # @example
+          #   require "google/cloud/redis"
+          #
+          #   cloud_redis_client = Google::Cloud::Redis.new(version: :v1beta1)
+          #   formatted_name = Google::Cloud::Redis::V1beta1::CloudRedisClient.instance_path("[PROJECT]", "[LOCATION]", "[INSTANCE]")
+          #
+          #   # TODO: Initialize `data_protection_mode`:
+          #   data_protection_mode = :DATA_PROTECTION_MODE_UNSPECIFIED
+          #
+          #   # Register a callback during the method call.
+          #   operation = cloud_redis_client.failover_instance(formatted_name, data_protection_mode) do |op|
+          #     raise op.results.message if op.error?
+          #     op_results = op.results
+          #     # Process the results.
+          #
+          #     metadata = op.metadata
+          #     # Process the metadata.
+          #   end
+          #
+          #   # Or use the return value to register a callback.
+          #   operation.on_done do |op|
+          #     raise op.results.message if op.error?
+          #     op_results = op.results
+          #     # Process the results.
+          #
+          #     metadata = op.metadata
+          #     # Process the metadata.
+          #   end
+          #
+          #   # Manually reload the operation.
+          #   operation.reload!
+          #
+          #   # Or block until the operation completes, triggering callbacks on
+          #   # completion.
+          #   operation.wait_until_done!
+
+          def failover_instance \
+              name,
+              data_protection_mode,
+              options: nil
+            req = {
+              name: name,
+              data_protection_mode: data_protection_mode
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Redis::V1beta1::FailoverInstanceRequest)
+            operation = Google::Gax::Operation.new(
+              @failover_instance.call(req, options),
+              @operations_client,
+              Google::Cloud::Redis::V1beta1::Instance,
+              Google::Protobuf::Any,
+              call_options: options
+            )
+            operation.on_done { |operation| yield(operation) } if block_given?
+            operation
+          end
         end
       end
     end

data/lib/google/cloud/redis/v1beta1/cloud_redis_client_config.json

@@ -44,6 +44,11 @@
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
+        },
+        "FailoverInstance": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
         }
       }
     }

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

@@ -5,6 +5,7 @@
 require 'google/protobuf'
 
 require 'google/api/annotations_pb'
+require 'google/api/resource_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
@@ -36,6 +37,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     value :DELETING, 4
     value :REPAIRING, 5
     value :MAINTENANCE, 6
+    value :IMPORTING, 8
+    value :FAILING_OVER, 10
   end
   add_enum "google.cloud.redis.v1beta1.Instance.Tier" do
     value :TIER_UNSPECIFIED, 0
@@ -50,6 +53,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.redis.v1beta1.ListInstancesResponse" do
     repeated :instances, :message, 1, "google.cloud.redis.v1beta1.Instance"
     optional :next_page_token, :string, 2
+    repeated :unreachable, :string, 3
   end
   add_message "google.cloud.redis.v1beta1.GetInstanceRequest" do
     optional :name, :string, 1
@@ -66,6 +70,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_message "google.cloud.redis.v1beta1.DeleteInstanceRequest" do
     optional :name, :string, 1
   end
+  add_message "google.cloud.redis.v1beta1.FailoverInstanceRequest" do
+    optional :name, :string, 1
+    optional :data_protection_mode, :enum, 2, "google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode"
+  end
+  add_enum "google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode" do
+    value :DATA_PROTECTION_MODE_UNSPECIFIED, 0
+    value :LIMITED_DATA_LOSS, 1
+    value :FORCE_DATA_LOSS, 2
+  end
   add_message "google.cloud.redis.v1beta1.LocationMetadata" do
     map :available_zones, :string, :message, 1, "google.cloud.redis.v1beta1.ZoneMetadata"
   end
@@ -86,6 +99,8 @@ module Google
         CreateInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.CreateInstanceRequest").msgclass
         UpdateInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.UpdateInstanceRequest").msgclass
         DeleteInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.DeleteInstanceRequest").msgclass
+        FailoverInstanceRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.FailoverInstanceRequest").msgclass
+        FailoverInstanceRequest::DataProtectionMode = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.FailoverInstanceRequest.DataProtectionMode").enummodule
         LocationMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.LocationMetadata").msgclass
         ZoneMetadata = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ZoneMetadata").msgclass
       end

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

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/cloud/redis/v1beta1/cloud_redis.proto for package 'google.cloud.redis.v1beta1'
 # Original file comments:
-# Copyright 2018 Google Inc.
+# Copyright 2019 Google LLC.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+#
 
 
 require 'grpc'
@@ -61,7 +62,7 @@ module Google
             rpc :GetInstance, GetInstanceRequest, Instance
             # Creates a Redis instance based on the specified tier and memory size.
             #
-            # By default, the instance is peered to the project's
+            # By default, the instance is accessible from the project's
             # [default network](/compute/docs/networks-and-firewalls#networks).
             #
             # The creation is executed asynchronously and callers may check the returned
@@ -78,6 +79,9 @@ module Google
             # 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
+            # Failover the master role to current replica node against a specific
+            # STANDARD tier redis instance.
+            rpc :FailoverInstance, FailoverInstanceRequest, Google::Longrunning::Operation
             # Deletes a specific Redis instance.  Instance stops serving and data is
             # deleted.
             rpc :DeleteInstance, DeleteInstanceRequest, Google::Longrunning::Operation

data/lib/google/cloud/redis/v1beta1/credentials.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/redis/v1beta1/doc/google/cloud/redis/v1beta1/cloud_redis.rb

@@ -1,4 +1,4 @@
-# Copyright 2018 Google LLC
+# Copyright 2019 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ module Google
         #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
         #
         #     Note: Redis instances are managed and addressed at regional level so
-        #     location_id here refers to a GCP region; however, users get to choose which
+        #     location_id here refers to a GCP region; however, users may choose which
         #     specific zone (or collection of zones for cross-zone instances) an instance
         #     should be provisioned in. Refer to [location_id] and
         #     [alternative_location_id] fields for more details.
@@ -40,7 +40,7 @@ module Google
         #     Optional. The zone where the instance will be provisioned. If not provided,
         #     the service will choose a zone for the instance. For STANDARD_HA tier,
         #     instances will be created across two zones for protection against zonal
-        #     failures. if [alternative_location_id] is also provided, it must be
+        #     failures. If [alternative_location_id] is also provided, it must be
         #     different from [location_id].
         # @!attribute [rw] alternative_location_id
         #   @return [String]
@@ -50,27 +50,32 @@ module Google
         # @!attribute [rw] redis_version
         #   @return [String]
         #     Optional. The version of Redis software.
-        #     If not provided, latest supported version will be used.
+        #     If not provided, latest supported version will be used. Updating the
+        #     version will perform an upgrade/downgrade to the new version. Currently,
+        #     the supported values are:
+        #
+        #     * `REDIS_4_0` for Redis 4.0 compatibility
+        #       * `REDIS_3_2` for Redis 3.2 compatibility (default)
         # @!attribute [rw] reserved_ip_range
         #   @return [String]
         #     Optional. The CIDR range of internal addresses that are reserved for this
         #     instance. If not provided, the service will choose an unused /29 block,
         #     for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique
-        #     and non-overlapping with existing subnets in a network.
+        #     and non-overlapping with existing subnets in an authorized network.
         # @!attribute [rw] host
         #   @return [String]
-        #     Output only. Hostname or IP address of the exposed redis endpoint used by
+        #     Output only. Hostname or IP address of the exposed Redis endpoint used by
         #     clients to connect to the service.
         # @!attribute [rw] port
         #   @return [Integer]
-        #     Output only. The port number of the exposed redis endpoint.
+        #     Output only. The port number of the exposed Redis endpoint.
         # @!attribute [rw] current_location_id
         #   @return [String]
-        #     Output only. The current zone where the Redis endpoint is placed. In
-        #     single zone deployments, this will always be the same as [location_id]
-        #     provided by the user at creation time. In cross-zone instances (only
-        #     applicable in STANDARD_HA tier), this can be either [location_id] or
-        #     [alternative_location_id] and can change on a failover event.
+        #     Output only. The current zone where the Redis endpoint is placed. For Basic
+        #     Tier instances, this will always be the same as the [location_id]
+        #     provided by the user at creation time. For Standard Tier instances,
+        #     this can be either [location_id] or [alternative_location_id] and can
+        #     change after a failover event.
         # @!attribute [rw] create_time
         #   @return [Google::Protobuf::Timestamp]
         #     Output only. The time the instance was created.
@@ -86,14 +91,23 @@ module Google
         #     Optional. Redis configuration parameters, according to
         #     http://redis.io/topics/config. Currently, the only supported parameters
         #     are:
+        #
+        #      Redis 3.2 and above:
+        #
         #     * maxmemory-policy
         #       * notify-keyspace-events
+        #
+        #       Redis 4.0 and above:
+        #
+        #     * activedefrag
+        #       * lfu-log-factor
+        #     * lfu-decay-time
         # @!attribute [rw] tier
         #   @return [Google::Cloud::Redis::V1beta1::Instance::Tier]
         #     Required. The service tier of the instance.
         # @!attribute [rw] memory_size_gb
         #   @return [Integer]
-        #     Required. Redis memory size in GB.
+        #     Required. Redis memory size in GiB.
         # @!attribute [rw] authorized_network
         #   @return [String]
         #     Optional. The full name of the Google Compute Engine
@@ -120,12 +134,17 @@ module Google
             # Redis instance is being deleted.
             DELETING = 4
 
-            # Redis instance is being repaired and may be unusable. Details can be
-            # found in the `status_message` field.
+            # Redis instance is being repaired and may be unusable.
             REPAIRING = 5
 
             # Maintenance is being performed on this Redis instance.
             MAINTENANCE = 6
+
+            # Redis instance is importing data (availability may be affected).
+            IMPORTING = 8
+
+            # Redis instance is failing over (availability may be affected).
+            FAILING_OVER = 10
           end
 
           # Available service tiers to choose from
@@ -141,7 +160,8 @@ module Google
           end
         end
 
-        # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::ListInstances ListInstances}.
+        # Request for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::ListInstances ListInstances}.
         # @!attribute [rw] parent
         #   @return [String]
         #     Required. The resource name of the instance location using the form:
@@ -162,7 +182,8 @@ module Google
         #     if any.
         class ListInstancesRequest; end
 
-        # Response for {Google::Cloud::Redis::V1beta1::CloudRedis::ListInstances ListInstances}.
+        # Response for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::ListInstances ListInstances}.
         # @!attribute [rw] instances
         #   @return [Array<Google::Cloud::Redis::V1beta1::Instance>]
         #     A list of Redis instances in the project in the specified location,
@@ -179,6 +200,9 @@ module Google
         #   @return [String]
         #     Token to retrieve the next page of results, or empty if there are no more
         #     results in the list.
+        # @!attribute [rw] unreachable
+        #   @return [Array<String>]
+        #     Locations that could not be reached.
         class ListInstancesResponse; end
 
         # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::GetInstance GetInstance}.
@@ -189,7 +213,8 @@ module Google
         #     where `location_id` refers to a GCP region
         class GetInstanceRequest; end
 
-        # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::CreateInstance CreateInstance}.
+        # Request for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::CreateInstance CreateInstance}.
         # @!attribute [rw] parent
         #   @return [String]
         #     Required. The resource name of the instance location using the form:
@@ -210,23 +235,26 @@ module Google
         #     Required. A Redis [Instance] resource
         class CreateInstanceRequest; end
 
-        # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::UpdateInstance UpdateInstance}.
+        # Request for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::UpdateInstance UpdateInstance}.
         # @!attribute [rw] update_mask
         #   @return [Google::Protobuf::FieldMask]
         #     Required. Mask of fields to update. At least one path must be supplied in
         #     this field. The elements of the repeated paths field may only include these
-        #     fields from {CloudRedis::Instance Instance}:
-        #     * `display_name`
-        #     * `labels`
-        #     * `memory_size_gb`
-        #     * `redis_config`
+        #     fields from {Google::Cloud::Redis::V1beta1::Instance Instance}:
+        #
+        #     * `displayName`
+        #       * `labels`
+        #     * `memorySizeGb`
+        #       * `redisConfig`
         # @!attribute [rw] instance
         #   @return [Google::Cloud::Redis::V1beta1::Instance]
         #     Required. Update description.
         #     Only fields specified in update_mask are updated.
         class UpdateInstanceRequest; end
 
-        # Request for {Google::Cloud::Redis::V1beta1::CloudRedis::DeleteInstance DeleteInstance}.
+        # Request for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::DeleteInstance DeleteInstance}.
         # @!attribute [rw] name
         #   @return [String]
         #     Required. Redis instance resource name using the form:
@@ -234,6 +262,32 @@ module Google
         #     where `location_id` refers to a GCP region
         class DeleteInstanceRequest; end
 
+        # Request for
+        # {Google::Cloud::Redis::V1beta1::CloudRedis::FailoverInstance Failover}.
+        # @!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] data_protection_mode
+        #   @return [Google::Cloud::Redis::V1beta1::FailoverInstanceRequest::DataProtectionMode]
+        #     Optional. Available data protection modes that the user can choose. If it's
+        #     unspecified, data protection mode will be LIMITED_DATA_LOSS by default.
+        class FailoverInstanceRequest
+          module DataProtectionMode
+            DATA_PROTECTION_MODE_UNSPECIFIED = 0
+
+            # Instance failover will be protected with data loss control. More
+            # specifically, the failover will only be performed if the current
+            # replication offset diff between master and replica is under a certain
+            # threshold.
+            LIMITED_DATA_LOSS = 1
+
+            # Instance failover will be performed without data loss control.
+            FORCE_DATA_LOSS = 2
+          end
+        end
+
         # This location metadata represents additional configuration options for a
         # given location where a Redis instance may be created. All fields are output
         # only. It is returned as content of the