google-cloud-spanner-admin-instance-v1 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b77f802b5b7428370dcd50b4ceffd81d869f8fbe81b9ef97d7c9b6140409e948
-  data.tar.gz: dd6f002271392c0525ad80536494c984fafad4f800188f4ee72b6c91742da966
+  metadata.gz: 5f2d6142626f53f74e67683af74c16442561cd0f0fbb80344e2dc633324f9457
+  data.tar.gz: 2ee80cd6dd93b806895aa7f72033daaa4574ae459e7c63831558db083a10fa68
 SHA512:
-  metadata.gz: 458b00e4baeec3f438f38b0e1f8d0f3f89c46db6d1f93844b11da55afdb5e02a2ba0cc0f6edd70f8ffc38415d44e0035cf95e0e0ea0fe6186394edbd91e7850c
-  data.tar.gz: 838b07af54c1432a08cf45852cd69d2223afd7b50029b0cd0ead13fa5a05d3d617b024080f6ff8ad26d4ad85c41584926a42e52f19989730a99492f91f1fc5d8
+  metadata.gz: 5fefaea816e28b3b48cbb9fba0e24719e8fbdaef52b17aa293541b8efad2acf4d960ed36267adf418ba88604cfc974f422e600411703f2a090619a7fc3007d4d
+  data.tar.gz: a497a5bfc3d2f3775c1b87a0b71c9459d270b754a5e4026b3bb3c40415e7fb0d470776bd051fe967483eb17c64eab7f76e4349d3263309c84fa08fc4c2f50994

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin/client.rb

@@ -426,38 +426,38 @@ module Google
                 end
 
                 ##
-                # Creates an instance config and begins preparing it to be used. The
+                # Creates an instance configuration and begins preparing it to be used. The
                 # returned {::Google::Longrunning::Operation long-running operation}
                 # can be used to track the progress of preparing the new
-                # instance config. The instance config name is assigned by the caller. If the
-                # named instance config already exists, `CreateInstanceConfig` returns
-                # `ALREADY_EXISTS`.
+                # instance configuration. The instance configuration name is assigned by the
+                # caller. If the named instance configuration already exists,
+                # `CreateInstanceConfig` returns `ALREADY_EXISTS`.
                 #
                 # Immediately after the request returns:
                 #
-                #   * The instance config is readable via the API, with all requested
-                #     attributes. The instance config's
+                #   * The instance configuration is readable via the API, with all requested
+                #     attributes. The instance configuration's
                 #     {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling reconciling}
                 #     field is set to true. Its state is `CREATING`.
                 #
                 # While the operation is pending:
                 #
-                #   * Cancelling the operation renders the instance config immediately
+                #   * Cancelling the operation renders the instance configuration immediately
                 #     unreadable via the API.
                 #   * Except for deleting the creating resource, all other attempts to modify
-                #     the instance config are rejected.
+                #     the instance configuration are rejected.
                 #
                 # Upon completion of the returned operation:
                 #
                 #   * Instances can be created using the instance configuration.
-                #   * The instance config's
+                #   * The instance configuration's
                 #   {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling reconciling}
                 #   field becomes false. Its state becomes `READY`.
                 #
                 # The returned {::Google::Longrunning::Operation long-running operation} will
                 # have a name of the format
                 # `<instance_config_name>/operations/<operation_id>` and can be used to track
-                # creation of the instance config. The
+                # creation of the instance configuration. The
                 # {::Google::Longrunning::Operation#metadata metadata} field type is
                 # {::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceConfigMetadata CreateInstanceConfigMetadata}.
                 # The {::Google::Longrunning::Operation#response response} field type is
@@ -484,13 +484,13 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param parent [::String]
-                #     Required. The name of the project in which to create the instance config.
-                #     Values are of the form `projects/<project>`.
+                #     Required. The name of the project in which to create the instance
+                #     configuration. Values are of the form `projects/<project>`.
                 #   @param instance_config_id [::String]
-                #     Required. The ID of the instance config to create.  Valid identifiers are
-                #     of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
+                #     Required. The ID of the instance configuration to create. Valid identifiers
+                #     are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64
                 #     characters in length. The `custom-` prefix is required to avoid name
-                #     conflicts with Google managed configurations.
+                #     conflicts with Google-managed configurations.
                 #   @param instance_config [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig, ::Hash]
                 #     Required. The InstanceConfig proto of the configuration to create.
                 #     instance_config.name must be
@@ -575,16 +575,16 @@ module Google
                 end
 
                 ##
-                # Updates an instance config. The returned
+                # Updates an instance configuration. The returned
                 # {::Google::Longrunning::Operation long-running operation} can be used to track
-                # the progress of updating the instance. If the named instance config does
-                # not exist, returns `NOT_FOUND`.
+                # the progress of updating the instance. If the named instance configuration
+                # does not exist, returns `NOT_FOUND`.
                 #
-                # Only user managed configurations can be updated.
+                # Only user-managed configurations can be updated.
                 #
                 # Immediately after the request returns:
                 #
-                #   * The instance config's
+                #   * The instance configuration's
                 #     {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling reconciling}
                 #     field is set to true.
                 #
@@ -594,23 +594,23 @@ module Google
                 #     {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceConfigMetadata#cancel_time cancel_time}.
                 #     The operation is guaranteed to succeed at undoing all changes, after
                 #     which point it terminates with a `CANCELLED` status.
-                #   * All other attempts to modify the instance config are rejected.
-                #   * Reading the instance config via the API continues to give the
+                #   * All other attempts to modify the instance configuration are rejected.
+                #   * Reading the instance configuration via the API continues to give the
                 #     pre-request values.
                 #
                 # Upon completion of the returned operation:
                 #
                 #   * Creating instances using the instance configuration uses the new
                 #     values.
-                #   * The instance config's new values are readable via the API.
-                #   * The instance config's
+                #   * The new values of the instance configuration are readable via the API.
+                #   * The instance configuration's
                 #   {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling reconciling}
                 #   field becomes false.
                 #
                 # The returned {::Google::Longrunning::Operation long-running operation} will
                 # have a name of the format
                 # `<instance_config_name>/operations/<operation_id>` and can be used to track
-                # the instance config modification.  The
+                # the instance configuration modification.  The
                 # {::Google::Longrunning::Operation#metadata metadata} field type is
                 # {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceConfigMetadata UpdateInstanceConfigMetadata}.
                 # The {::Google::Longrunning::Operation#response response} field type is
@@ -636,8 +636,9 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param instance_config [::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig, ::Hash]
-                #     Required. The user instance config to update, which must always include the
-                #     instance config name. Otherwise, only fields mentioned in
+                #     Required. The user instance configuration to update, which must always
+                #     include the instance configuration name. Otherwise, only fields mentioned
+                #     in
                 #     {::Google::Cloud::Spanner::Admin::Instance::V1::UpdateInstanceConfigRequest#update_mask update_mask}
                 #     need be included. To prevent conflicts of concurrent updates,
                 #     {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#reconciling etag} can
@@ -727,11 +728,11 @@ module Google
                 end
 
                 ##
-                # Deletes the instance config. Deletion is only allowed when no
+                # Deletes the instance configuration. Deletion is only allowed when no
                 # instances are using the configuration. If any instances are using
-                # the config, returns `FAILED_PRECONDITION`.
+                # the configuration, returns `FAILED_PRECONDITION`.
                 #
-                # Only user managed configurations can be deleted.
+                # Only user-managed configurations can be deleted.
                 #
                 # Authorization requires `spanner.instanceConfigs.delete` permission on
                 # the resource {::Google::Cloud::Spanner::Admin::Instance::V1::InstanceConfig#name name}.
@@ -757,12 +758,12 @@ module Google
                 #     `projects/<project>/instanceConfigs/<instance_config>`
                 #   @param etag [::String]
                 #     Used for optimistic concurrency control as a way to help prevent
-                #     simultaneous deletes of an instance config from overwriting each
+                #     simultaneous deletes of an instance configuration from overwriting each
                 #     other. If not empty, the API
-                #     only deletes the instance config when the etag provided matches the current
-                #     status of the requested instance config. Otherwise, deletes the instance
-                #     config without checking the current status of the requested instance
-                #     config.
+                #     only deletes the instance configuration when the etag provided matches the
+                #     current status of the requested instance configuration. Otherwise, deletes
+                #     the instance configuration without checking the current status of the
+                #     requested instance configuration.
                 #   @param validate_only [::Boolean]
                 #     An option to validate, but not actually execute, a request,
                 #     and provide the same response.
@@ -833,9 +834,9 @@ module Google
                 end
 
                 ##
-                # Lists the user-managed instance config [long-running
+                # Lists the user-managed instance configuration [long-running
                 # operations][google.longrunning.Operation] in the given project. An instance
-                # config operation has a name of the form
+                # configuration operation has a name of the form
                 # `projects/<project>/instanceConfigs/<instance_config>/operations/<operation>`.
                 # The long-running operation
                 # {::Google::Longrunning::Operation#metadata metadata} field type
@@ -861,7 +862,7 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param parent [::String]
-                #     Required. The project of the instance config operations.
+                #     Required. The project of the instance configuration operations.
                 #     Values are of the form `projects/<project>`.
                 #   @param filter [::String]
                 #     An expression that filters the list of returned operations.
@@ -904,7 +905,7 @@ module Google
                 #         `(error:*)` - Return operations where:
                 #         * The operation's metadata type is
                 #         {::Google::Cloud::Spanner::Admin::Instance::V1::CreateInstanceConfigMetadata CreateInstanceConfigMetadata}.
-                #         * The instance config name contains "custom-config".
+                #         * The instance configuration name contains "custom-config".
                 #         * The operation started before 2021-03-28T14:50:00Z.
                 #         * The operation resulted in an error.
                 #   @param page_size [::Integer]
@@ -2621,6 +2622,164 @@ module Google
                   raise ::Google::Cloud::Error.from_error(e)
                 end
 
+                ##
+                # Moves an instance to the target instance configuration. You can use the
+                # returned {::Google::Longrunning::Operation long-running operation} to track
+                # the progress of moving the instance.
+                #
+                # `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of
+                # the following criteria:
+                #
+                #   * Is undergoing a move to a different instance configuration
+                #   * Has backups
+                #   * Has an ongoing update
+                #   * Contains any CMEK-enabled databases
+                #   * Is a free trial instance
+                #
+                # While the operation is pending:
+                #
+                #   * All other attempts to modify the instance, including changes to its
+                #     compute capacity, are rejected.
+                #   * The following database and backup admin operations are rejected:
+                #
+                #     * `DatabaseAdmin.CreateDatabase`
+                #     * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is
+                #        specified in the request.)
+                #     * `DatabaseAdmin.RestoreDatabase`
+                #     * `DatabaseAdmin.CreateBackup`
+                #     * `DatabaseAdmin.CopyBackup`
+                #
+                #   * Both the source and target instance configurations are subject to
+                #     hourly compute and storage charges.
+                #   * The instance might experience higher read-write latencies and a higher
+                #     transaction abort rate. However, moving an instance doesn't cause any
+                #     downtime.
+                #
+                # The returned {::Google::Longrunning::Operation long-running operation} has
+                # a name of the format
+                # `<instance_name>/operations/<operation_id>` and can be used to track
+                # the move instance operation. The
+                # {::Google::Longrunning::Operation#metadata metadata} field type is
+                # {::Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceMetadata MoveInstanceMetadata}.
+                # The {::Google::Longrunning::Operation#response response} field type is
+                # {::Google::Cloud::Spanner::Admin::Instance::V1::Instance Instance},
+                # if successful.
+                # Cancelling the operation sets its metadata's
+                # {::Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceMetadata#cancel_time cancel_time}.
+                # Cancellation is not immediate because it involves moving any data
+                # previously moved to the target instance configuration back to the original
+                # instance configuration. You can use this operation to track the progress of
+                # the cancellation. Upon successful completion of the cancellation, the
+                # operation terminates with `CANCELLED` status.
+                #
+                # If not cancelled, upon completion of the returned operation:
+                #
+                #   * The instance successfully moves to the target instance
+                #     configuration.
+                #   * You are billed for compute and storage in target instance
+                #   configuration.
+                #
+                # Authorization requires the `spanner.instances.update` permission on
+                # the resource {::Google::Cloud::Spanner::Admin::Instance::V1::Instance instance}.
+                #
+                # For more details, see
+                # [Move an instance](https://cloud.google.com/spanner/docs/move-instance).
+                #
+                # @overload move_instance(request, options = nil)
+                #   Pass arguments to `move_instance` via a request object, either of type
+                #   {::Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceRequest, ::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 move_instance(name: nil, target_config: nil)
+                #   Pass arguments to `move_instance` 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 name [::String]
+                #     Required. The instance to move.
+                #     Values are of the form `projects/<project>/instances/<instance>`.
+                #   @param target_config [::String]
+                #     Required. The target instance configuration where to move the instance.
+                #     Values are of the form `projects/<project>/instanceConfigs/<config>`.
+                #
+                # @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/spanner/admin/instance/v1"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdmin::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceRequest.new
+                #
+                #   # Call the move_instance method.
+                #   result = client.move_instance 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 move_instance request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Spanner::Admin::Instance::V1::MoveInstanceRequest
+
+                  # 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.move_instance.metadata.to_h
+
+                  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Spanner::Admin::Instance::V1::VERSION
+                  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  header_params = {}
+                  if request.name
+                    header_params["name"] = request.name
+                  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.move_instance.timeout,
+                                         metadata:     metadata,
+                                         retry_policy: @config.rpcs.move_instance.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @instance_admin_stub.call_rpc :move_instance, 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 InstanceAdmin API.
                 #
@@ -2874,6 +3033,11 @@ module Google
                     # @return [::Gapic::Config::Method]
                     #
                     attr_reader :list_instance_partition_operations
+                    ##
+                    # RPC-specific configuration for `move_instance`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :move_instance
 
                     # @private
                     def initialize parent_rpcs = nil
@@ -2917,6 +3081,8 @@ module Google
                       @update_instance_partition = ::Gapic::Config::Method.new update_instance_partition_config
                       list_instance_partition_operations_config = parent_rpcs.list_instance_partition_operations if parent_rpcs.respond_to? :list_instance_partition_operations
                       @list_instance_partition_operations = ::Gapic::Config::Method.new list_instance_partition_operations_config
+                      move_instance_config = parent_rpcs.move_instance if parent_rpcs.respond_to? :move_instance
+                      @move_instance = ::Gapic::Config::Method.new move_instance_config
 
                       yield self if block_given?
                     end