google-cloud-memcache-v1 0.2.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 278406c53987654873c2809f008420b246581fe8740b2f214d0445b53ba454fc
-  data.tar.gz: 04fc77447e49ee608004eece18220cf05db5d7d63ce15131e3cb3ccb2bd1d26f
+  metadata.gz: bc79a4cc37fadef741fe07b88e9904a00c1aa16436d251c1661c9c3c47285b61
+  data.tar.gz: 169f349cbf4c95481e05ccd40cf14219b557acdf192dee3066028d46a000cb9c
 SHA512:
-  metadata.gz: 76a88069257b54c5d9e1ce7c7ab5278bbeb88d179c7887b7fedd437006fd2c73f29cfa2bca266c56b31a47ede7f2729e9ed9cbb471885cc95cb35e6a2fb32974
-  data.tar.gz: 6247e787487d63f51eae4868034a200afd7e65a36042c998339bffe751be14a65c3d87624a61f772995216b9d4105fae3e71cbc811746593f95e625902ec20f3
+  metadata.gz: 3832b363ab2c6cd3288708b4e7c2f18746ac00c6db9ef0c63d6dcfa83a9e6346b04e5ed374c393308c4b5a87d898697407b9ca0ab8f37647d7400570033f2da8
+  data.tar.gz: 3c17eaf9825bac0fdebdad1c5ec7913ddf826f20528211aed4422c579acca76e33ea5b45be32e762876bc356882d8cce272c36db44316a5b197a22371dca65cd

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -37,7 +37,7 @@ request = ::Google::Cloud::Memcache::V1::ListInstancesRequest.new # (request fie
 response = client.list_instances request
 ```
 
-View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-memcache-v1/latest)
+View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-memcache-v1/latest)
 for class and method documentation.
 
 See also the [Product Documentation](https://cloud.google.com/memorystore/docs/memcached/)
@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

data/lib/google/cloud/memcache/v1/cloud_memcache/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/memcache/v1/cloud_memcache_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -92,6 +93,8 @@ module Google
 
                 default_config.rpcs.apply_parameters.timeout = 1200.0
 
+                default_config.rpcs.reschedule_maintenance.timeout = 1200.0
+
                 default_config
               end
               yield @configure if block_given?
@@ -167,6 +170,12 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @cloud_memcache_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Memcache::V1::CloudMemcache::Stub,
                 credentials:  credentials,
@@ -183,6 +192,13 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -211,16 +227,15 @@ 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.
             #   @param page_token [::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.
             #   @param filter [::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"`.
             #   @param order_by [::String]
             #     Sort results. Supported values are "name", "name desc" or "" (unsorted).
             #
@@ -412,9 +427,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.
             #   @param instance [::Google::Cloud::Memcache::V1::Instance, ::Hash]
             #     Required. A Memcached Instance
             #
@@ -510,6 +525,7 @@ module Google
             #
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
             #     Required. Mask of fields to update.
+            #
             #      *   `displayName`
             #   @param instance [::Google::Cloud::Memcache::V1::Instance, ::Hash]
             #     Required. A Memcached Instance.
@@ -588,9 +604,10 @@ module Google
             end
 
             ##
-            # Updates the defined Memcached Parameters for an existing Instance.
+            # Updates the defined Memcached parameters for an existing instance.
             # This method only stages the parameters, it must be followed by
-            # ApplyParameters to apply the parameters to nodes of the Memcached Instance.
+            # `ApplyParameters` to apply the parameters to nodes of the Memcached
+            # instance.
             #
             # @overload update_parameters(request, options = nil)
             #   Pass arguments to `update_parameters` via a request object, either of type
@@ -783,7 +800,7 @@ module Google
             end
 
             ##
-            # ApplyParameters will restart the set of specified nodes in order to update
+            # `ApplyParameters` restarts the set of specified nodes in order to update
             # them to the current set of parameters for the Memcached Instance.
             #
             # @overload apply_parameters(request, options = nil)
@@ -805,11 +822,11 @@ module Google
             #     Required. Resource name of the Memcached instance for which parameter group updates
             #     should be applied.
             #   @param node_ids [::Array<::String>]
-            #     Nodes to which we should apply the instance-level parameter group.
+            #     Nodes to which the instance-level parameter group is applied.
             #   @param apply_all [::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.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -883,6 +900,107 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Reschedules upcoming maintenance event.
+            #
+            # @overload reschedule_maintenance(request, options = nil)
+            #   Pass arguments to `reschedule_maintenance` via a request object, either of type
+            #   {::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload reschedule_maintenance(instance: nil, reschedule_type: nil, schedule_time: nil)
+            #   Pass arguments to `reschedule_maintenance` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param instance [::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.
+            #   @param reschedule_type [::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest::RescheduleType]
+            #     Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
+            #   @param schedule_time [::Google::Protobuf::Timestamp, ::Hash]
+            #     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`.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Gapic::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Gapic::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/memcache/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Memcache::V1::CloudMemcache::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest.new
+            #
+            #   # Call the reschedule_maintenance method.
+            #   result = client.reschedule_maintenance request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
+            def reschedule_maintenance request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.reschedule_maintenance.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Memcache::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.instance
+                header_params["instance"] = request.instance
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.reschedule_maintenance.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.reschedule_maintenance.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @cloud_memcache_stub.call_rpc :reschedule_maintenance, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the CloudMemcache API.
             #
@@ -1053,6 +1171,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :apply_parameters
+                ##
+                # RPC-specific configuration for `reschedule_maintenance`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :reschedule_maintenance
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -1070,6 +1193,8 @@ module Google
                   @delete_instance = ::Gapic::Config::Method.new delete_instance_config
                   apply_parameters_config = parent_rpcs.apply_parameters if parent_rpcs.respond_to? :apply_parameters
                   @apply_parameters = ::Gapic::Config::Method.new apply_parameters_config
+                  reschedule_maintenance_config = parent_rpcs.reschedule_maintenance if parent_rpcs.respond_to? :reschedule_maintenance
+                  @reschedule_maintenance = ::Gapic::Config::Method.new reschedule_maintenance_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/memcache/v1/cloud_memcache/operations.rb

@@ -95,6 +95,9 @@ module Google
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors
               )
+
+              # Used by an LRO wrapper for some methods of this service
+              @operations_client = self
             end
 
             # Service calls

data/lib/google/cloud/memcache/v1/cloud_memcache_pb.rb

@@ -1,14 +1,18 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/memcache/v1/cloud_memcache.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf/duration_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
+require 'google/type/dayofweek_pb'
+require 'google/type/timeofday_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/memcache/v1/cloud_memcache.proto", :syntax => :proto3) do
@@ -29,6 +33,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :memcache_full_version, :string, 18
       repeated :instance_messages, :message, 19, "google.cloud.memcache.v1.Instance.InstanceMessage"
       optional :discovery_endpoint, :string, 20
+      optional :maintenance_policy, :message, 21, "google.cloud.memcache.v1.MaintenancePolicy"
+      optional :maintenance_schedule, :message, 22, "google.cloud.memcache.v1.MaintenanceSchedule"
     end
     add_message "google.cloud.memcache.v1.Instance.NodeConfig" do
       optional :cpu_count, :int32, 1
@@ -61,9 +67,37 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :STATE_UNSPECIFIED, 0
       value :CREATING, 1
       value :READY, 2
+      value :UPDATING, 3
       value :DELETING, 4
       value :PERFORMING_MAINTENANCE, 5
     end
+    add_message "google.cloud.memcache.v1.MaintenancePolicy" do
+      optional :create_time, :message, 1, "google.protobuf.Timestamp"
+      optional :update_time, :message, 2, "google.protobuf.Timestamp"
+      optional :description, :string, 3
+      repeated :weekly_maintenance_window, :message, 4, "google.cloud.memcache.v1.WeeklyMaintenanceWindow"
+    end
+    add_message "google.cloud.memcache.v1.WeeklyMaintenanceWindow" do
+      optional :day, :enum, 1, "google.type.DayOfWeek"
+      optional :start_time, :message, 2, "google.type.TimeOfDay"
+      optional :duration, :message, 3, "google.protobuf.Duration"
+    end
+    add_message "google.cloud.memcache.v1.MaintenanceSchedule" do
+      optional :start_time, :message, 1, "google.protobuf.Timestamp"
+      optional :end_time, :message, 2, "google.protobuf.Timestamp"
+      optional :schedule_deadline_time, :message, 4, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.memcache.v1.RescheduleMaintenanceRequest" do
+      optional :instance, :string, 1
+      optional :reschedule_type, :enum, 2, "google.cloud.memcache.v1.RescheduleMaintenanceRequest.RescheduleType"
+      optional :schedule_time, :message, 3, "google.protobuf.Timestamp"
+    end
+    add_enum "google.cloud.memcache.v1.RescheduleMaintenanceRequest.RescheduleType" do
+      value :RESCHEDULE_TYPE_UNSPECIFIED, 0
+      value :IMMEDIATE, 1
+      value :NEXT_AVAILABLE_WINDOW, 2
+      value :SPECIFIC_TIME, 3
+    end
     add_message "google.cloud.memcache.v1.ListInstancesRequest" do
       optional :parent, :string, 1
       optional :page_size, :int32, 2
@@ -114,6 +148,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :cancel_requested, :bool, 6
       optional :api_version, :string, 7
     end
+    add_message "google.cloud.memcache.v1.LocationMetadata" do
+      map :available_zones, :string, :message, 1, "google.cloud.memcache.v1.ZoneMetadata"
+    end
+    add_message "google.cloud.memcache.v1.ZoneMetadata" do
+    end
     add_enum "google.cloud.memcache.v1.MemcacheVersion" do
       value :MEMCACHE_VERSION_UNSPECIFIED, 0
       value :MEMCACHE_1_5, 1
@@ -132,6 +171,11 @@ module Google
         Instance::InstanceMessage = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.Instance.InstanceMessage").msgclass
         Instance::InstanceMessage::Code = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.Instance.InstanceMessage.Code").enummodule
         Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.Instance.State").enummodule
+        MaintenancePolicy = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.MaintenancePolicy").msgclass
+        WeeklyMaintenanceWindow = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.WeeklyMaintenanceWindow").msgclass
+        MaintenanceSchedule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.MaintenanceSchedule").msgclass
+        RescheduleMaintenanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.RescheduleMaintenanceRequest").msgclass
+        RescheduleMaintenanceRequest::RescheduleType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.RescheduleMaintenanceRequest.RescheduleType").enummodule
         ListInstancesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.ListInstancesRequest").msgclass
         ListInstancesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.ListInstancesResponse").msgclass
         GetInstanceRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.GetInstanceRequest").msgclass
@@ -142,6 +186,8 @@ module Google
         UpdateParametersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.UpdateParametersRequest").msgclass
         MemcacheParameters = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.MemcacheParameters").msgclass
         OperationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.OperationMetadata").msgclass
+        LocationMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.LocationMetadata").msgclass
+        ZoneMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.ZoneMetadata").msgclass
         MemcacheVersion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.memcache.v1.MemcacheVersion").enummodule
       end
     end

data/lib/google/cloud/memcache/v1/cloud_memcache_services_pb.rb

@@ -55,15 +55,18 @@ module Google
             rpc :CreateInstance, ::Google::Cloud::Memcache::V1::CreateInstanceRequest, ::Google::Longrunning::Operation
             # Updates an existing Instance in a given project and location.
             rpc :UpdateInstance, ::Google::Cloud::Memcache::V1::UpdateInstanceRequest, ::Google::Longrunning::Operation
-            # Updates the defined Memcached Parameters for an existing Instance.
+            # Updates the defined Memcached parameters for an existing instance.
             # This method only stages the parameters, it must be followed by
-            # ApplyParameters to apply the parameters to nodes of the Memcached Instance.
+            # `ApplyParameters` to apply the parameters to nodes of the Memcached
+            # instance.
             rpc :UpdateParameters, ::Google::Cloud::Memcache::V1::UpdateParametersRequest, ::Google::Longrunning::Operation
             # Deletes a single Instance.
             rpc :DeleteInstance, ::Google::Cloud::Memcache::V1::DeleteInstanceRequest, ::Google::Longrunning::Operation
-            # ApplyParameters will restart the set of specified nodes in order to update
+            # `ApplyParameters` restarts the set of specified nodes in order to update
             # them to the current set of parameters for the Memcached Instance.
             rpc :ApplyParameters, ::Google::Cloud::Memcache::V1::ApplyParametersRequest, ::Google::Longrunning::Operation
+            # Reschedules upcoming maintenance event.
+            rpc :RescheduleMaintenance, ::Google::Cloud::Memcache::V1::RescheduleMaintenanceRequest, ::Google::Longrunning::Operation
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/memcache/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Memcache
       module V1
-        VERSION = "0.2.5"
+        VERSION = "0.4.0"
       end
     end
   end

data/lib/google/cloud/memcache/v1.rb

@@ -25,6 +25,8 @@ module Google
       ##
       # To load this package, including all its services, and instantiate a client:
       #
+      # @example
+      #
       #     require "google/cloud/memcache/v1"
       #     client = ::Google::Cloud::Memcache::V1::CloudMemcache::Client.new
       #