google-cloud-redis-v1beta1 0.4.3 → 0.6.0

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]
@@ -42,15 +54,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 +74,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 +150,52 @@ 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] auth_enabled
+        #   @return [::Boolean]
+        #     Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to
+        #     "true" AUTH is enabled on the instance. Default value is "false" meaning
+        #     AUTH is disabled.
+        # @!attribute [r] server_ca_certs
+        #   @return [::Array<::Google::Cloud::Redis::V1beta1::TlsCertificate>]
+        #     Output only. List of server CA certificates for the instance.
+        # @!attribute [rw] transit_encryption_mode
+        #   @return [::Google::Cloud::Redis::V1beta1::Instance::TransitEncryptionMode]
+        #     Optional. The TLS mode of the Redis instance.
+        #     If not provided, TLS is disabled for the instance.
+        # @!attribute [rw] maintenance_policy
+        #   @return [::Google::Cloud::Redis::V1beta1::MaintenancePolicy]
+        #     Optional. The maintenance policy for the instance. If not provided,
+        #     maintenance events can be performed at any time.
+        # @!attribute [r] maintenance_schedule
+        #   @return [::Google::Cloud::Redis::V1beta1::MaintenanceSchedule]
+        #     Output only. Date and time of upcoming maintenance events which have been
+        #     scheduled.
+        # @!attribute [rw] replica_count
+        #   @return [::Integer]
+        #     Optional. The number of replica nodes. The valid range for the Standard Tier with
+        #     read replicas enabled is [1-5] and defaults to 2. If read replicas are not
+        #     enabled for a Standard Tier instance, the only valid value is 1 and the
+        #     default is 1. The valid value for basic tier is 0 and the default is also
+        #     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. Can only be specified when trying to create the
+        #     instance.
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -207,13 +267,133 @@ 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
+
+          # Available TLS modes.
+          module TransitEncryptionMode
+            # Not set.
+            TRANSIT_ENCRYPTION_MODE_UNSPECIFIED = 0
+
+            # Client to Server traffic encryption enabled with server authentication.
+            SERVER_AUTHENTICATION = 1
+
+            # TLS is disabled for the instance.
+            DISABLED = 2
+          end
+
+          # Read replicas mode.
+          module ReadReplicasMode
+            # If not set, Memorystore Redis backend will default to
+            # READ_REPLICAS_DISABLED.
+            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. Not valid for basic tier.
+            READ_REPLICAS_ENABLED = 2
+          end
+        end
+
+        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#reschedule_maintenance RescheduleMaintenance}.
+        # @!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] reschedule_type
+        #   @return [::Google::Cloud::Redis::V1beta1::RescheduleMaintenanceRequest::RescheduleType]
+        #     Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
+        # @!attribute [rw] schedule_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Optional. Timestamp when the maintenance shall be rescheduled to if
+        #     reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for
+        #     example `2012-11-15T16:19:00.094Z`.
+        class RescheduleMaintenanceRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Reschedule options.
+          module RescheduleType
+            # Not set.
+            RESCHEDULE_TYPE_UNSPECIFIED = 0
+
+            # If the user wants to schedule the maintenance to happen now.
+            IMMEDIATE = 1
+
+            # If the user wants to use the existing maintenance policy to find the
+            # next available window.
+            NEXT_AVAILABLE_WINDOW = 2
+
+            # If the user wants to reschedule the maintenance to a specific time.
+            SPECIFIC_TIME = 3
+          end
+        end
+
+        # Maintenance policy for an instance.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the policy was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the policy was last updated.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. Description of what this policy is for. Create/Update methods
+        #     return INVALID_ARGUMENT if the length is greater than 512.
+        # @!attribute [rw] weekly_maintenance_window
+        #   @return [::Array<::Google::Cloud::Redis::V1beta1::WeeklyMaintenanceWindow>]
+        #     Optional. Maintenance window that is applied to resources covered by this
+        #     policy. Minimum 1. For the current version, the maximum number of
+        #     weekly_window is expected to be one.
+        class MaintenancePolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Time window in which disruptive maintenance updates occur. Non-disruptive
+        # updates can occur inside or outside this window.
+        # @!attribute [rw] day
+        #   @return [::Google::Type::DayOfWeek]
+        #     Required. The day of week that maintenance updates occur.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Type::TimeOfDay]
+        #     Required. Start time of the window in UTC time.
+        # @!attribute [r] duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Output only. Duration of the maintenance window. The current window is fixed at 1 hour.
+        class WeeklyMaintenanceWindow
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Upcoming maintenance schedule. If no maintenance is scheduled, fields are not
+        # populated.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The start time of any upcoming scheduled maintenance for this instance.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The end time of any upcoming scheduled maintenance for this instance.
+        # @!attribute [rw] can_reschedule
+        #   @return [::Boolean]
+        #     If the scheduled maintenance can be rescheduled, default is true.
+        # @!attribute [r] schedule_deadline_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The deadline that the maintenance schedule start time can not go beyond,
+        #     including reschedule.
+        class MaintenanceSchedule
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
         # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#list_instances ListInstances}.
@@ -248,11 +428,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,6 +457,26 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#get_instance_auth_string GetInstanceAuthString}.
+        # @!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.
+        class GetInstanceAuthStringRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Instance AUTH string details.
+        # @!attribute [rw] auth_string
+        #   @return [::String]
+        #     AUTH string set on the instance.
+        class InstanceAuthString
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request for {::Google::Cloud::Redis::V1beta1::CloudRedis::Client#create_instance CreateInstance}.
         # @!attribute [rw] parent
         #   @return [::String]
@@ -311,6 +512,7 @@ module Google
         #      *   `labels`
         #      *   `memorySizeGb`
         #      *   `redisConfig`
+        #      *   `replica_count`
         # @!attribute [rw] instance
         #   @return [::Google::Cloud::Redis::V1beta1::Instance]
         #     Required. Update description.
@@ -432,7 +634,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
 
@@ -471,6 +673,31 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # TlsCertificate Resource
+        # @!attribute [rw] serial_number
+        #   @return [::String]
+        #     Serial number, as extracted from the certificate.
+        # @!attribute [rw] cert
+        #   @return [::String]
+        #     PEM representation.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the certificate was created in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2020-05-18T00:00:00.094Z`.
+        # @!attribute [r] expire_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the certificate expires in [RFC
+        #     3339](https://tools.ietf.org/html/rfc3339) format, for example
+        #     `2020-05-18T00:00:00.094Z`.
+        # @!attribute [rw] sha1_fingerprint
+        #   @return [::String]
+        #     Sha1 Fingerprint of the certificate.
+        class TlsCertificate
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/type/dayofweek.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a day of the week.
+    module DayOfWeek
+      # The day of the week is unspecified.
+      DAY_OF_WEEK_UNSPECIFIED = 0
+
+      # Monday
+      MONDAY = 1
+
+      # Tuesday
+      TUESDAY = 2
+
+      # Wednesday
+      WEDNESDAY = 3
+
+      # Thursday
+      THURSDAY = 4
+
+      # Friday
+      FRIDAY = 5
+
+      # Saturday
+      SATURDAY = 6
+
+      # Sunday
+      SUNDAY = 7
+    end
+  end
+end

data/proto_docs/google/type/timeofday.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Type
+    # Represents a time of day. The date and time zone are either not significant
+    # or are specified elsewhere. An API may choose to allow leap seconds. Related
+    # types are [google.type.Date][google.type.Date] and
+    # `google.protobuf.Timestamp`.
+    # @!attribute [rw] hours
+    #   @return [::Integer]
+    #     Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
+    #     to allow the value "24:00:00" for scenarios like business closing time.
+    # @!attribute [rw] minutes
+    #   @return [::Integer]
+    #     Minutes of hour of day. Must be from 0 to 59.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Seconds of minutes of the time. Must normally be from 0 to 59. An API may
+    #     allow the value 60 if it allows leap-seconds.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+    class TimeOfDay
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-redis-v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -190,6 +190,8 @@ files:
 - proto_docs/google/protobuf/field_mask.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
+- proto_docs/google/type/dayofweek.rb
+- proto_docs/google/type/timeofday.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Cloud Memorystore for Redis V1beta1 API