google-cloud-memcache-v1 0.3.0 → 0.5.0

data/proto_docs/google/cloud/memcache/v1/cloud_memcache.rb

@@ -21,19 +21,20 @@ module Google
   module Cloud
     module Memcache
       module V1
+        # A Memorystore for Memcached instance
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. Unique name of the resource in this scope including project and
         #     location using the form:
         #         `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
         #
-        #     Note: Memcached instances are managed and addressed at regional level so
-        #     location_id here refers to a GCP region; however, users may choose which
-        #     zones Memcached nodes within an instances should be provisioned in.
-        #     Refer to [zones] field for more details.
+        #     Note: Memcached instances are managed and addressed at the regional level
+        #     so `location_id` here refers to a Google Cloud region; however, users may
+        #     choose which zones Memcached nodes should be provisioned in within an
+        #     instance. Refer to {::Google::Cloud::Memcache::V1::Instance#zones zones} field for more details.
         # @!attribute [rw] display_name
         #   @return [::String]
-        #     User provided name for the instance only used for display
+        #     User provided name for the instance, which is only used for display
         #     purposes. Cannot be more than 80 characters.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
@@ -48,7 +49,7 @@ module Google
         #     will be used.
         # @!attribute [rw] zones
         #   @return [::Array<::String>]
-        #     Zones where Memcached nodes should be provisioned in.
+        #     Zones in which Memcached nodes should be provisioned.
         #     Memcached nodes will be equally distributed across these zones. If not
         #     provided, the service will by default create nodes in all zones in the
         #     region for the instance.
@@ -62,17 +63,17 @@ module Google
         #   @return [::Google::Cloud::Memcache::V1::MemcacheVersion]
         #     The major version of Memcached software.
         #     If not provided, latest supported version will be used. Currently the
-        #     latest supported major version is MEMCACHE_1_5.
+        #     latest supported major version is `MEMCACHE_1_5`.
         #     The minor version will be automatically determined by our system based on
         #     the latest supported minor version.
         # @!attribute [rw] parameters
         #   @return [::Google::Cloud::Memcache::V1::MemcacheParameters]
-        #     Optional: User defined parameters to apply to the memcached process
+        #     User defined parameters to apply to the memcached process
         #     on each node.
         # @!attribute [r] memcache_nodes
         #   @return [::Array<::Google::Cloud::Memcache::V1::Instance::Node>]
         #     Output only. List of Memcached nodes.
-        #     Refer to [Node] message for more details.
+        #     Refer to {::Google::Cloud::Memcache::V1::Instance::Node Node} message for more details.
         # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The time the instance was created.
@@ -90,10 +91,18 @@ module Google
         #     The full version format will be "memcached-1.5.16".
         # @!attribute [rw] instance_messages
         #   @return [::Array<::Google::Cloud::Memcache::V1::Instance::InstanceMessage>]
-        #     List of messages that describe current statuses of memcached instance.
+        #     List of messages that describe the current state of the Memcached instance.
         # @!attribute [r] discovery_endpoint
         #   @return [::String]
-        #     Output only. Endpoint for Discovery API
+        #     Output only. Endpoint for the Discovery API.
+        # @!attribute [rw] maintenance_policy
+        #   @return [::Google::Cloud::Memcache::V1::MaintenancePolicy]
+        #     The maintenance policy for the instance. If not provided,
+        #     the maintenance event will be performed based on Memorystore
+        #     internal rollout schedule.
+        # @!attribute [r] maintenance_schedule
+        #   @return [::Google::Cloud::Memcache::V1::MaintenanceSchedule]
+        #     Output only. Published maintenance schedule.
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,6 +201,10 @@ module Google
             # Memcached instance has been created and ready to be used.
             READY = 2
 
+            # Memcached instance is updating configuration such as maintenance policy
+            # and schedule.
+            UPDATING = 3
+
             # Memcached instance is being deleted.
             DELETING = 4
 
@@ -200,6 +213,93 @@ module Google
           end
         end
 
+        # Maintenance policy per 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 updated.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     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::Memcache::V1::WeeklyMaintenanceWindow>]
+        #     Required. Maintenance window that is applied to resources covered by this
+        #     policy. Minimum 1. For the current version, the maximum number of
+        #     weekly_maintenance_windows is expected to be one.
+        class MaintenancePolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Time window specified for weekly operations.
+        # @!attribute [rw] day
+        #   @return [::Google::Type::DayOfWeek]
+        #     Required. Allows to define schedule that runs specified day of the week.
+        # @!attribute [rw] start_time
+        #   @return [::Google::Type::TimeOfDay]
+        #     Required. Start time of the window in UTC.
+        # @!attribute [rw] duration
+        #   @return [::Google::Protobuf::Duration]
+        #     Required. Duration of the time window.
+        class WeeklyMaintenanceWindow
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Upcoming maintenance schedule.
+        # @!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 [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::Memcache::V1::CloudMemcache::Client#reschedule_maintenance RescheduleMaintenance}.
+        # @!attribute [rw] instance
+        #   @return [::String]
+        #     Required. Memcache 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::Memcache::V1::RescheduleMaintenanceRequest::RescheduleType]
+        #     Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
+        # @!attribute [rw] schedule_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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
+
         # Request for {::Google::Cloud::Memcache::V1::CloudMemcache::Client#list_instances ListInstances}.
         # @!attribute [rw] parent
         #   @return [::String]
@@ -211,18 +311,17 @@ module Google
         #     The maximum number of items to return.
         #
         #     If not specified, a default value of 1000 will be used by the service.
-        #     Regardless of the page_size value, the response may include a partial list
-        #     and a caller should only rely on response's
-        #     [next_page_token][CloudMemcache.ListInstancesResponse.next_page_token]
+        #     Regardless of the `page_size` value, the response may include a partial
+        #     list and a caller should only rely on response's
+        #     {::Google::Cloud::Memcache::V1::ListInstancesResponse#next_page_token `next_page_token`}
         #     to determine if there are more instances left to be queried.
         # @!attribute [rw] page_token
         #   @return [::String]
-        #     The next_page_token value returned from a previous List request,
-        #     if any.
+        #     The `next_page_token` value returned from a previous List request, if any.
         # @!attribute [rw] filter
         #   @return [::String]
         #     List filter. For example, exclude all Memcached instances with name as
-        #     my-instance by specifying "name != my-instance".
+        #     my-instance by specifying `"name != my-instance"`.
         # @!attribute [rw] order_by
         #   @return [::String]
         #     Sort results. Supported values are "name", "name desc" or "" (unsorted).
@@ -277,9 +376,9 @@ module Google
         #     * Must start with a letter.
         #     * Must be between 1-40 characters.
         #     * Must end with a number or a letter.
-        #     * Must be unique within the user project / location
+        #     * Must be unique within the user project / location.
         #
-        #     If any of the above are not met, will raise an invalid argument error.
+        #     If any of the above are not met, the API raises an invalid argument error.
         # @!attribute [rw] instance
         #   @return [::Google::Cloud::Memcache::V1::Instance]
         #     Required. A Memcached Instance
@@ -292,6 +391,7 @@ module Google
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Required. Mask of fields to update.
+        #
         #      *   `displayName`
         # @!attribute [rw] instance
         #   @return [::Google::Cloud::Memcache::V1::Instance]
@@ -320,12 +420,12 @@ module Google
         #     should be applied.
         # @!attribute [rw] node_ids
         #   @return [::Array<::String>]
-        #     Nodes to which we should apply the instance-level parameter group.
+        #     Nodes to which the instance-level parameter group is applied.
         # @!attribute [rw] apply_all
         #   @return [::Boolean]
         #     Whether to apply instance-level parameter group to all nodes. If set to
-        #     true, will explicitly restrict users from specifying any nodes, and apply
-        #     parameter group updates to all nodes within the instance.
+        #     true, users are restricted from specifying individual nodes, and
+        #     `ApplyParameters` updates all nodes within the instance.
         class ApplyParametersRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -351,8 +451,9 @@ module Google
         #   @return [::String]
         #     Output only. The unique ID associated with this set of parameters. Users
         #     can use this id to determine if the parameters associated with the instance
-        #     differ from the parameters associated with the nodes and any action needs
-        #     to be taken to apply parameters on nodes.
+        #     differ from the parameters associated with the nodes. A discrepancy between
+        #     parameter ids can inform users that they may need to take action to apply
+        #     parameters on nodes.
         # @!attribute [rw] params
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     User defined set of parameters to use in the memcached process.
@@ -400,6 +501,31 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Metadata for the given `::Google::Cloud::Location::Location`.
+        # @!attribute [r] available_zones
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Memcache::V1::ZoneMetadata}]
+        #     Output only. The set of available zones in the location. The map is keyed
+        #     by the lowercase ID of each zone, as defined by GCE. These keys can be
+        #     specified in the `zones` field when creating a Memcached instance.
+        class LocationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Memcache::V1::ZoneMetadata]
+          class AvailableZonesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        class ZoneMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Memcached versions supported by our service.
         module MemcacheVersion
           MEMCACHE_VERSION_UNSPECIFIED = 0

data/proto_docs/google/protobuf/empty.rb

@@ -26,8 +26,6 @@ module Google
     #     service Foo {
     #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
     #     }
-    #
-    # The JSON representation for `Empty` is empty JSON object `{}`.
     class Empty
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/rpc/status.rb

@@ -28,12 +28,14 @@ module Google
     # [API Design Guide](https://cloud.google.com/apis/design/errors).
     # @!attribute [rw] code
     #   @return [::Integer]
-    #     The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
+    #     The status code, which should be an enum value of
+    #     [google.rpc.Code][google.rpc.Code].
     # @!attribute [rw] message
     #   @return [::String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
+    #     {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
+    #     by the client.
     # @!attribute [rw] details
     #   @return [::Array<::Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of

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-memcache-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,20 +44,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -171,16 +191,24 @@ files:
 - README.md
 - lib/google-cloud-memcache-v1.rb
 - lib/google/cloud/memcache/v1.rb
+- lib/google/cloud/memcache/v1/bindings_override.rb
 - lib/google/cloud/memcache/v1/cloud_memcache.rb
 - lib/google/cloud/memcache/v1/cloud_memcache/client.rb
 - lib/google/cloud/memcache/v1/cloud_memcache/credentials.rb
 - lib/google/cloud/memcache/v1/cloud_memcache/operations.rb
 - lib/google/cloud/memcache/v1/cloud_memcache/paths.rb
+- lib/google/cloud/memcache/v1/cloud_memcache/rest.rb
+- lib/google/cloud/memcache/v1/cloud_memcache/rest/client.rb
+- lib/google/cloud/memcache/v1/cloud_memcache/rest/operations.rb
+- lib/google/cloud/memcache/v1/cloud_memcache/rest/service_stub.rb
 - lib/google/cloud/memcache/v1/cloud_memcache_pb.rb
 - lib/google/cloud/memcache/v1/cloud_memcache_services_pb.rb
+- lib/google/cloud/memcache/v1/rest.rb
 - lib/google/cloud/memcache/v1/version.rb
 - proto_docs/README.md
+- proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/memcache/v1/cloud_memcache.rb
 - proto_docs/google/longrunning/operations.rb
@@ -190,6 +218,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,8 +239,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
-summary: API Client library for the Google Cloud Memorystore for Memcached V1 API
+summary: Google Cloud Memorystore for Memcached API is used for creating and managing
+  Memcached instances in GCP.
 test_files: []