google-cloud-memcache-v1 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bc6ad70ed40e55d1d4340a54c0f508971097955468c063e24db09792b6403b0
-  data.tar.gz: 3067886824d642dacf03d7b87a2b7af3aae89ea48a05c3f97bc1ee3b1d2cea49
+  metadata.gz: 9d5b101df76e47180f366a6a5acc49c7de7963dfdae129935d69e6602234d6cc
+  data.tar.gz: 24951d294951436cb68e372826f2db88819ce0a9b566a559731ee9e4390231c9
 SHA512:
-  metadata.gz: d848f3b0cf229dcc6b6a35848a75e2ff15872ec9007b73ed45546f94f0c303ffc3f0fff558075b95613cb0997633994cad4e8169b2c632be01cc9e615f4c06d3
-  data.tar.gz: 836c5c947ca656741ea092d958eb7eb5f5ea844683cc8a36abc562f721bfff865289039e65a19dd8a6a5739f3ddf4cea10ecde152858793bf0d3ff9b823fe90e
+  metadata.gz: 4f85333ead1097df6ae3c8d5cc2782be2d7d15c3f81e9a7ae53ac98e62614678010f728394674d868a2983135ff72565d7f84f784501b1c423cfccb07428fc29
+  data.tar.gz: 5c0c96605b6b8cdf226e5657ba35b951a169da6ce21e3fdb309402323d3ed7be068ebd4f285aefa24efceb15d13267f3d092dcce0fcf616d3834d2b02debfa1e

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

@@ -1,6 +1,6 @@
 # Ruby Client for the Google Cloud Memorystore for Memcached V1 API
 
-API Client library for the Google Cloud Memorystore for Memcached V1 API
+Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.
 
 Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.
 
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
 or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/config"
+
+module Google
+  module Cloud
+    module Memcache
+      ##
+      # @example Loading just the REST part of this package, including all its services, and instantiating a REST client
+      #
+      #     require "google/cloud/memcache/v1/rest"
+      #     client = ::Google::Cloud::Memcache::V1::CloudMemcache::Rest::Client.new
+      #
+      module V1
+        ##
+        # @private
+        # Initialize the mixin bindings configuration
+        #
+        def self.configure
+          @configure ||= begin
+            namespace = ["Google", "Cloud", "Memcache"]
+            parent_config = while namespace.any?
+                              parent_name = namespace.join "::"
+                              parent_const = const_get parent_name
+                              break parent_const.configure if parent_const.respond_to? :configure
+                              namespace.pop
+                            end
+
+            default_config = Configuration.new parent_config
+            default_config.bindings_override["google.cloud.location.Locations.GetLocation"] = [
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}",
+                matches: [
+                  ["name", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config.bindings_override["google.cloud.location.Locations.ListLocations"] = [
+
+              Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
+                uri_method: :get,
+                uri_template: "/v1/{name}/locations",
+                matches: [
+                  ["name", %r{^projects/[^/]+/?$}, false]
+                ],
+                body: nil
+              )
+            ]
+            default_config
+          end
+          yield @configure if block_given?
+          @configure
+        end
+
+        ##
+        # @private
+        # Configuration class for the google.cloud.memcache.v1 package.
+        #
+        # This class contains common configuration for all services
+        # of the google.cloud.memcache.v1 package.
+        #
+        # This configuration is for internal use of the client library classes,
+        # and it is not intended that the end-users will read or change it.
+        #
+        class Configuration
+          extend ::Gapic::Config
+
+          # @private
+          # Overrides for http bindings for the RPC of the mixins for this package.
+          # Services in this package should use these when creating clients for the mixin services.
+          # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
+          config_attr :bindings_override, {}, ::Hash, nil
+
+          # @private
+          def initialize parent_config = nil
+            @parent_config = parent_config unless parent_config.nil?
+
+            yield self if block_given?
+          end
+        end
+      end
+    end
+  end
+end

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).
             #
@@ -244,13 +259,11 @@ module Google
             #   # Call the list_instances method.
             #   result = client.list_instances request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Memcache::V1::Instance.
-            #     p response
+            #     p item
             #   end
             #
             def list_instances request, options = nil
@@ -412,9 +425,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
             #
@@ -438,14 +451,14 @@ module Google
             #   # Call the create_instance method.
             #   result = client.create_instance 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def create_instance request, options = nil
@@ -510,6 +523,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.
@@ -535,14 +549,14 @@ module Google
             #   # Call the update_instance method.
             #   result = client.update_instance 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def update_instance request, options = nil
@@ -588,9 +602,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
@@ -635,14 +650,14 @@ module Google
             #   # Call the update_parameters method.
             #   result = client.update_parameters 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def update_parameters request, options = nil
@@ -730,14 +745,14 @@ module Google
             #   # Call the delete_instance method.
             #   result = client.delete_instance 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def delete_instance request, options = nil
@@ -783,7 +798,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 +820,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]
@@ -831,14 +846,14 @@ module Google
             #   # Call the apply_parameters method.
             #   result = client.apply_parameters 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def apply_parameters request, options = nil
@@ -883,6 +898,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 it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "No response received."
+            #   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 +1169,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 +1191,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

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation 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:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil