google-cloud-redis-v1beta1 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e12e7634080ac529236383495c9737b8f8482e239eb4206939a6ecad6727e51
-  data.tar.gz: e191a618b8521b268ecebe4eb6e78a6eb351690b7332ff03013008cf819e7ef6
+  metadata.gz: 1105f4624b4b93ab6c2f859320dd1b37a97a6f69fba13737b1f3bee7cff2d426
+  data.tar.gz: 35192cf9f1e9545ac9a55bfce4be0d57bf3c9a0ef55fde0234aa1e29c8752382
 SHA512:
-  metadata.gz: 7d196c0aadc2888794b9de4f3b497e43b88477aa683c091c4e673bb175c1c5d90fc912979b6d79916155f66aa539896af1b672d2d748027efc7fc8d88670e2db
-  data.tar.gz: e9c8f5c897b555a05d24b4428994af2e9c74c75a37a65453e3dac5ae415d45c6cf7bb4176b583a50ed56895e939ac51396baeb1185fd63ac68a91b6a641ae119
+  metadata.gz: 4d547d83d8c0c64eab6b6e43a83924ad5e128bf9996f419cdf8165e23cf07d8b58e1a55708df99e5741330a9f7ca1ce20296c588b124732b2645d5ad82967909
+  data.tar.gz: c4a33f65bf851cb44aa844bf148b3d8ca96d95c712d04850f4bce09fc3eb780852ead08e3fdbea3e9320d34774bbc2354d01dc8561f5cff16a8024d470444e88

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

@@ -40,7 +40,7 @@ module Google
           # * As such, Redis instances are resources of the form:
           #   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
           #
-          # Note that location_id must be refering to a GCP `region`; for example:
+          # Note that location_id must be referring to a GCP `region`; for example:
           # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
           #
           class Client
@@ -228,7 +228,8 @@ module Google
             #     to determine if there are more instances left to be queried.
             #   @param page_token [::String]
             #     The `next_page_token` value returned from a previous
-            #     {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances} request, if any.
+            #     {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}
+            #     request, if any.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Redis::V1beta1::Instance>]
@@ -396,7 +397,7 @@ module Google
             #
             # The creation is executed asynchronously and callers may check the returned
             # operation to track its progress. Once the operation is completed the Redis
-            # instance will be fully functional. Completed longrunning.Operation will
+            # instance will be fully functional. The 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
@@ -536,6 +537,7 @@ module Google
             #      *   `labels`
             #      *   `memorySizeGb`
             #      *   `redisConfig`
+            #      *   `replica_count`
             #   @param instance [::Google::Cloud::Redis::V1beta1::Instance, ::Hash]
             #     Required. Update description.
             #     Only fields specified in update_mask are updated.
@@ -917,7 +919,7 @@ module Google
             end
 
             ##
-            # Initiates a failover of the master node to current replica node for a
+            # Initiates a failover of the primary node to current replica node for a
             # specific STANDARD tier Cloud Memorystore for Redis instance.
             #
             # @overload failover_instance(request, options = nil)

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

@@ -45,7 +45,7 @@ module Google
         # * As such, Redis instances are resources of the form:
         #   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
         #
-        # Note that location_id must be refering to a GCP `region`; for example:
+        # Note that location_id must be referring to a GCP `region`; for example:
         # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
         #
         # To load this service and instantiate a client:

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

@@ -12,6 +12,10 @@ require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/redis/v1beta1/cloud_redis.proto", :syntax => :proto3) do
+    add_message "google.cloud.redis.v1beta1.NodeInfo" do
+      optional :id, :string, 1
+      optional :zone, :string, 2
+    end
     add_message "google.cloud.redis.v1beta1.Instance" do
       optional :name, :string, 1
       optional :display_name, :string, 2
@@ -32,6 +36,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :authorized_network, :string, 20
       optional :persistence_iam_identity, :string, 21
       optional :connect_mode, :enum, 22, "google.cloud.redis.v1beta1.Instance.ConnectMode"
+      optional :replica_count, :int32, 31
+      repeated :nodes, :message, 32, "google.cloud.redis.v1beta1.NodeInfo"
+      optional :read_endpoint, :string, 33
+      optional :read_endpoint_port, :int32, 34
+      optional :read_replicas_mode, :enum, 35, "google.cloud.redis.v1beta1.Instance.ReadReplicasMode"
     end
     add_enum "google.cloud.redis.v1beta1.Instance.State" do
       value :STATE_UNSPECIFIED, 0
@@ -54,6 +63,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :DIRECT_PEERING, 1
       value :PRIVATE_SERVICE_ACCESS, 2
     end
+    add_enum "google.cloud.redis.v1beta1.Instance.ReadReplicasMode" do
+      value :READ_REPLICAS_MODE_UNSPECIFIED, 0
+      value :READ_REPLICAS_DISABLED, 1
+      value :READ_REPLICAS_ENABLED, 2
+    end
     add_message "google.cloud.redis.v1beta1.ListInstancesRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -128,10 +142,12 @@ module Google
   module Cloud
     module Redis
       module V1beta1
+        NodeInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.NodeInfo").msgclass
         Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance").msgclass
         Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.State").enummodule
         Instance::Tier = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.Tier").enummodule
         Instance::ConnectMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.ConnectMode").enummodule
+        Instance::ReadReplicasMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.Instance.ReadReplicasMode").enummodule
         ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ListInstancesRequest").msgclass
         ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.ListInstancesResponse").msgclass
         GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.redis.v1beta1.GetInstanceRequest").msgclass

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

@@ -37,7 +37,7 @@ module Google
           # * As such, Redis instances are resources of the form:
           #   `/projects/{project_id}/locations/{location_id}/instances/{instance_id}`
           #
-          # Note that location_id must be refering to a GCP `region`; for example:
+          # Note that location_id must be referring to a GCP `region`; for example:
           # * `projects/redpepper-1290/locations/us-central1/instances/my-redis`
           class Service
 
@@ -66,7 +66,7 @@ module Google
             #
             # The creation is executed asynchronously and callers may check the returned
             # operation to track its progress. Once the operation is completed the Redis
-            # instance will be fully functional. Completed longrunning.Operation will
+            # instance will be fully functional. The 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
@@ -97,7 +97,7 @@ module Google
             # The returned operation is automatically deleted after a few hours, so
             # there is no need to call DeleteOperation.
             rpc :ExportInstance, ::Google::Cloud::Redis::V1beta1::ExportInstanceRequest, ::Google::Longrunning::Operation
-            # Initiates a failover of the master node to current replica node for a
+            # Initiates a failover of the primary node to current replica node for a
             # specific STANDARD tier Cloud Memorystore for Redis instance.
             rpc :FailoverInstance, ::Google::Cloud::Redis::V1beta1::FailoverInstanceRequest, ::Google::Longrunning::Operation
             # Deletes a specific Redis instance.  Instance stops serving and data is

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Redis
       module V1beta1
-        VERSION = "0.4.4"
+        VERSION = "0.5.0"
       end
     end
   end

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

@@ -21,6 +21,18 @@ module Google
   module Cloud
     module Redis
       module V1beta1
+        # Node specific properties.
+        # @!attribute [r] id
+        #   @return [::String]
+        #     Output only. Node identifying string. e.g. 'node-0', 'node-1'
+        # @!attribute [r] zone
+        #   @return [::String]
+        #     Output only. Location of the node.
+        class NodeInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A Google Cloud Redis instance.
         # @!attribute [rw] name
         #   @return [::String]
@@ -31,8 +43,10 @@ module Google
         #     Note: Redis instances are managed and addressed at regional level so
         #     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 {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id} and
-        #     {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id} fields for more details.
+        #     should be provisioned in. Refer to
+        #     {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id} and
+        #     {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id}
+        #     fields for more details.
         # @!attribute [rw] display_name
         #   @return [::String]
         #     An arbitrary and optional user-provided name for the instance.
@@ -42,15 +56,17 @@ module Google
         # @!attribute [rw] location_id
         #   @return [::String]
         #     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 {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id} is also provided, it must be
-        #     different from {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id}.
+        #     the service will choose a zone from the specified region for the instance.
+        #     For standard tier, additional nodes will be added across multiple zones for
+        #     protection against zonal failures. If specified, at least one node will be
+        #     provisioned in this zone.
         # @!attribute [rw] alternative_location_id
         #   @return [::String]
-        #     Optional. Only applicable to STANDARD_HA tier which protects the instance
-        #     against zonal failures by provisioning it across two zones. If provided, it
-        #     must be a different zone from the one provided in {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id}.
+        #     Optional. If specified, at least one node will be provisioned in this zone
+        #     in addition to the zone specified in location_id. Only applicable to
+        #     standard tier. If provided, it must be a different zone from the one
+        #     provided in [location_id]. Additional nodes beyond the first 2 will be
+        #     placed in zones selected by the service.
         # @!attribute [rw] redis_version
         #   @return [::String]
         #     Optional. The version of Redis software.
@@ -60,26 +76,29 @@ module Google
         #      *   `REDIS_3_2` for Redis 3.2 compatibility
         #      *   `REDIS_4_0` for Redis 4.0 compatibility (default)
         #      *   `REDIS_5_0` for Redis 5.0 compatibility
+        #      *   `REDIS_6_X` for Redis 6.x compatibility
         # @!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 an authorized network.
+        #     Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses
+        #     that are reserved for this instance. Range must
+        #     be unique and non-overlapping with existing subnets in an authorized
+        #     network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP
+        #     address ranges associated with this private service access connection.
+        #     If not provided, the service will choose an unused /29 block, for
+        #     example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED
+        #     the default block size is /28.
         # @!attribute [r] host
         #   @return [::String]
         #     Output only. Hostname or IP address of the exposed Redis endpoint used by
-        #     clients to connect to the service.
+        #      clients to connect to the service.
         # @!attribute [r] port
         #   @return [::Integer]
         #     Output only. The port number of the exposed Redis endpoint.
         # @!attribute [r] current_location_id
         #   @return [::String]
-        #     Output only. The current zone where the Redis endpoint is placed. For Basic
-        #     Tier instances, this will always be the same as the {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id}
-        #     provided by the user at creation time. For Standard Tier instances,
-        #     this can be either {::Google::Cloud::Redis::V1beta1::Instance#location_id location_id} or {::Google::Cloud::Redis::V1beta1::Instance#alternative_location_id alternative_location_id} and can
-        #     change after a failover event.
+        #     Output only. The current zone where the Redis primary node is located. In
+        #     basic tier, this will always be the same as [location_id]. In
+        #     standard tier, this can be the zone of any node in the instance.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time the instance was created.
@@ -133,9 +152,29 @@ module Google
         #     operation.
         # @!attribute [rw] connect_mode
         #   @return [::Google::Cloud::Redis::V1beta1::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.
+        # @!attribute [rw] replica_count
+        #   @return [::Integer]
+        #     Optional. The number of replica nodes. Valid range for standard tier
+        #     is [1-5] and defaults to 1. Valid value for basic tier is 0 and defaults
+        #     to 0.
+        # @!attribute [r] nodes
+        #   @return [::Array<::Google::Cloud::Redis::V1beta1::NodeInfo>]
+        #     Output only. Info per node.
+        # @!attribute [r] read_endpoint
+        #   @return [::String]
+        #     Output only. Hostname or IP address of the exposed readonly Redis
+        #     endpoint. Standard tier only. Targets all healthy replica nodes in
+        #     instance. Replication is asynchronous and replica nodes will exhibit some
+        #     lag behind the primary. Write requests must target 'host'.
+        # @!attribute [r] read_endpoint_port
+        #   @return [::Integer]
+        #     Output only. The port number of the exposed readonly redis
+        #     endpoint. Standard tier only. Write requests should target 'port'.
+        # @!attribute [rw] read_replicas_mode
+        #   @return [::Google::Cloud::Redis::V1beta1::Instance::ReadReplicasMode]
+        #     Optional. Read replica mode.
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -207,16 +246,33 @@ 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
+
+          # Read replicas mode.
+          module ReadReplicasMode
+            # If not set, Memorystore for Redis backend will pick the mode based on
+            # other fields in the request.
+            READ_REPLICAS_MODE_UNSPECIFIED = 0
+
+            # If disabled, read endpoint will not be provided and the instance cannot
+            # scale up or down the number of replicas.
+            READ_REPLICAS_DISABLED = 1
+
+            # If enabled, read endpoint will be provided and the instance can scale
+            # up and down the number of replicas.
+            READ_REPLICAS_ENABLED = 2
+          end
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The resource name of the instance location using the form:
@@ -234,13 +290,15 @@ module Google
         # @!attribute [rw] page_token
         #   @return [::String]
         #     The `next_page_token` value returned from a previous
-        #     {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances} request, if any.
+        #     {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}
+        #     request, if any.
         class ListInstancesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
+        # Response for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
         # @!attribute [rw] instances
         #   @return [::Array<::Google::Cloud::Redis::V1beta1::Instance>]
         #     A list of Redis instances in the project in the specified location,
@@ -248,11 +306,12 @@ module Google
         #
         #     If the `location_id` in the parent field of the request is "-", all regions
         #     available to the project are queried, and the results aggregated.
-        #     If in such an aggregated query a location is unavailable, a dummy Redis
-        #     entry is included in the response with the `name` field set to a value of
-        #     the form `projects/{project_id}/locations/{location_id}/instances/`- and
-        #     the `status` field set to ERROR and `status_message` field set to "location
-        #     not available for ListInstances".
+        #     If in such an aggregated query a location is unavailable, a placeholder
+        #     Redis entry is included in the response with the `name` field set to a
+        #     value of the form
+        #     `projects/{project_id}/locations/{location_id}/instances/`- and the
+        #     `status` field set to ERROR and `status_message` field set to "location not
+        #     available for ListInstances".
         # @!attribute [rw] next_page_token
         #   @return [::String]
         #     Token to retrieve the next page of results, or empty if there are no more
@@ -276,7 +335,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#create_instance CreateInstance}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#create_instance CreateInstance}.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The resource name of the instance location using the form:
@@ -300,7 +360,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#update_instance UpdateInstance}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#update_instance UpdateInstance}.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Required. Mask of fields to update. At least one path must be supplied in
@@ -311,6 +372,7 @@ module Google
         #      *   `labels`
         #      *   `memorySizeGb`
         #      *   `redisConfig`
+        #      *   `replica_count`
         # @!attribute [rw] instance
         #   @return [::Google::Cloud::Redis::V1beta1::Instance]
         #     Required. Update description.
@@ -320,7 +382,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#upgrade_instance UpgradeInstance}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Redis instance resource name using the form:
@@ -334,7 +397,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#delete_instance DeleteInstance}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#delete_instance DeleteInstance}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Redis instance resource name using the form:
@@ -410,7 +474,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#failover_instance Failover}.
+        # Request for
+        # {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#failover_instance Failover}.
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Redis instance resource name using the form:
@@ -432,7 +497,7 @@ module Google
 
             # 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
+            # replication offset diff between primary and replica is under a certain
             # threshold.
             LIMITED_DATA_LOSS = 1
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-redis-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common