google-cloud-spanner-admin-database-v1 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6929ebcdea92158c0fad9c88ab18ca86cb421e901e4ba3a99f06e6985c0606f8
-  data.tar.gz: 1afdec85fdeaadf2e9b34261a223c69143ea3bf3d62b446e4d3c65e6d0f193f7
+  metadata.gz: a0ccba22ec473311d535a4a9ec4f1d63be050ca80ae187550ad5419b67ed4186
+  data.tar.gz: b9b3b52d6758e734fefb309638b24dec4d0f5d9b778f7ad17fc3ad8d87b5cdde
 SHA512:
-  metadata.gz: 46a4bdf68256441bbe8baf778177e5a5dbe8b9596c89befdefcc22a272bd437aa0a2dc34efe0b95155bff3d0577e5f96c1f6d77f9ac598a2a138323e31fca43c
-  data.tar.gz: e916351643479cb10eb263e5b55c780bdad6699eed851d405e52b24fb2cf351fd3197ad35ad714defa3368ef153a2561804cb00707230f2317084d745419487f
+  metadata.gz: 183dcd7dc9b8cf46f6b0e66576a77f755a42f0ba736462eb8cfc6ffc3b7fa07012c2a1982eb205dc1f97d2faecca6478e23cf680fea63545fd05bdd0d4378700
+  data.tar.gz: 73f6bd6d455658a016a16ed91e53eab5098dc883eae2b5312e90d6b621025b3a7d69171b20eab7bb248eba60e5903cf1f12e3fcafb26590d829c1de9b8f0699f

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 Cloud Spanner Database Admin V1 API
 
-API Client library for the Cloud Spanner Database Admin V1 API
+Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
 
 Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.
 
@@ -46,8 +46,8 @@ 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,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+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://cloud.google.com/ruby/docs/reference/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/spanner/admin/database/v1/database_admin/client.rb

@@ -84,6 +84,11 @@ module Google
                       initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
                     }
 
+                    default_config.rpcs.update_database.timeout = 3600.0
+                    default_config.rpcs.update_database.retry_policy = {
+                      initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
+                    }
+
                     default_config.rpcs.update_database_ddl.timeout = 3600.0
                     default_config.rpcs.update_database_ddl.retry_policy = {
                       initial_delay: 1.0, max_delay: 32.0, multiplier: 1.3, retry_codes: [14, 4]
@@ -291,13 +296,11 @@ module Google
                 #   # Call the list_databases method.
                 #   result = client.list_databases 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::Spanner::Admin::Database::V1::Database.
-                #     p response
+                #     p item
                 #   end
                 #
                 def list_databases request, options = nil
@@ -408,14 +411,14 @@ module Google
                 #   # Call the create_database method.
                 #   result = client.create_database 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_database request, options = nil
@@ -546,6 +549,139 @@ module Google
                   raise ::Google::Cloud::Error.from_error(e)
                 end
 
+                ##
+                # Updates a Cloud Spanner database. The returned
+                # {::Google::Longrunning::Operation long-running operation} can be used to track
+                # the progress of updating the database. If the named database does not
+                # exist, returns `NOT_FOUND`.
+                #
+                # While the operation is pending:
+                #
+                #   * The database's
+                #     {::Google::Cloud::Spanner::Admin::Database::V1::Database#reconciling reconciling}
+                #     field is set to true.
+                #   * Cancelling the operation is best-effort. If the cancellation succeeds,
+                #     the operation metadata's
+                #     {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseMetadata#cancel_time cancel_time}
+                #     is set, the updates are reverted, and the operation terminates with a
+                #     `CANCELLED` status.
+                #   * New UpdateDatabase requests will return a `FAILED_PRECONDITION` error
+                #     until the pending operation is done (returns successfully or with
+                #     error).
+                #   * Reading the database via the API continues to give the pre-request
+                #     values.
+                #
+                # Upon completion of the returned operation:
+                #
+                #   * The new values are in effect and readable via the API.
+                #   * The database's
+                #     {::Google::Cloud::Spanner::Admin::Database::V1::Database#reconciling reconciling}
+                #     field becomes false.
+                #
+                # The returned {::Google::Longrunning::Operation long-running operation} will
+                # have a name of the format
+                # `projects/<project>/instances/<instance>/databases/<database>/operations/<operation_id>`
+                # and can be used to track the database modification. The
+                # {::Google::Longrunning::Operation#metadata metadata} field type is
+                # {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseMetadata UpdateDatabaseMetadata}.
+                # The {::Google::Longrunning::Operation#response response} field type is
+                # {::Google::Cloud::Spanner::Admin::Database::V1::Database Database}, if successful.
+                #
+                # @overload update_database(request, options = nil)
+                #   Pass arguments to `update_database` via a request object, either of type
+                #   {::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest} or an equivalent Hash.
+                #
+                #   @param request [::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest, ::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 update_database(database: nil, update_mask: nil)
+                #   Pass arguments to `update_database` 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 database [::Google::Cloud::Spanner::Admin::Database::V1::Database, ::Hash]
+                #     Required. The database to update.
+                #     The `name` field of the database is of the form
+                #     `projects/<project>/instances/<instance>/databases/<database>`.
+                #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+                #     Required. The list of fields to update. Currently, only
+                #     `enable_drop_protection` field can be updated.
+                #
+                # @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/database/v1"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdmin::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest.new
+                #
+                #   # Call the update_database method.
+                #   result = client.update_database 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 update_database request, options = nil
+                  raise ::ArgumentError, "request must be provided" if request.nil?
+
+                  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Spanner::Admin::Database::V1::UpdateDatabaseRequest
+
+                  # 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.update_database.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::Spanner::Admin::Database::V1::VERSION
+                  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                  header_params = {}
+                  if request.database&.name
+                    header_params["database.name"] = request.database.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.update_database.timeout,
+                                         metadata:     metadata,
+                                         retry_policy: @config.rpcs.update_database.retry_policy
+
+                  options.apply_defaults timeout:      @config.timeout,
+                                         metadata:     @config.metadata,
+                                         retry_policy: @config.retry_policy
+
+                  @database_admin_stub.call_rpc :update_database, 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
+
                 ##
                 # Updates the schema of a Cloud Spanner database by
                 # creating/altering/dropping tables, columns, indexes, etc. The returned
@@ -615,14 +751,14 @@ module Google
                 #   # Call the update_database_ddl method.
                 #   result = client.update_database_ddl 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_database_ddl request, options = nil
@@ -1213,14 +1349,14 @@ module Google
                 #   # Call the create_backup method.
                 #   result = client.create_backup 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_backup request, options = nil
@@ -1341,14 +1477,14 @@ module Google
                 #   # Call the copy_backup method.
                 #   result = client.copy_backup 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 copy_backup request, options = nil
@@ -1749,13 +1885,11 @@ module Google
                 #   # Call the list_backups method.
                 #   result = client.list_backups 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::Spanner::Admin::Database::V1::Backup.
-                #     p response
+                #     p item
                 #   end
                 #
                 def list_backups request, options = nil
@@ -1876,14 +2010,14 @@ module Google
                 #   # Call the restore_database method.
                 #   result = client.restore_database 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 restore_database request, options = nil
@@ -2028,13 +2162,11 @@ module Google
                 #   # Call the list_database_operations method.
                 #   result = client.list_database_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_database_operations request, options = nil
@@ -2206,13 +2338,11 @@ module Google
                 #   # Call the list_backup_operations method.
                 #   result = client.list_backup_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_backup_operations request, options = nil
@@ -2308,13 +2438,11 @@ module Google
                 #   # Call the list_database_roles method.
                 #   result = client.list_database_roles 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::Spanner::Admin::Database::V1::DatabaseRole.
-                #     p response
+                #     p item
                 #   end
                 #
                 def list_database_roles request, options = nil
@@ -2397,9 +2525,9 @@ module Google
                 #    *  (`String`) The path to a service account key file in JSON format
                 #    *  (`Hash`) A service account key as a Hash
                 #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-                #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+                #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
                 #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-                #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+                #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
                 #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
                 #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
                 #    *  (`nil`) indicating no credentials
@@ -2510,6 +2638,11 @@ module Google
                     #
                     attr_reader :get_database
                     ##
+                    # RPC-specific configuration for `update_database`
+                    # @return [::Gapic::Config::Method]
+                    #
+                    attr_reader :update_database
+                    ##
                     # RPC-specific configuration for `update_database_ddl`
                     # @return [::Gapic::Config::Method]
                     #
@@ -2598,6 +2731,8 @@ module Google
                       @create_database = ::Gapic::Config::Method.new create_database_config
                       get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
                       @get_database = ::Gapic::Config::Method.new get_database_config
+                      update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
+                      @update_database = ::Gapic::Config::Method.new update_database_config
                       update_database_ddl_config = parent_rpcs.update_database_ddl if parent_rpcs.respond_to? :update_database_ddl
                       @update_database_ddl = ::Gapic::Config::Method.new update_database_ddl_config
                       drop_database_config = parent_rpcs.drop_database if parent_rpcs.respond_to? :drop_database

data/lib/google/cloud/spanner/admin/database/v1/database_admin/operations.rb

@@ -160,13 +160,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
@@ -255,14 +253,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
@@ -542,14 +540,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
@@ -624,9 +622,9 @@ module Google
                 #    *  (`String`) The path to a service account key file in JSON format
                 #    *  (`Hash`) A service account key as a Hash
                 #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-                #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+                #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
                 #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-                #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+                #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
                 #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
                 #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
                 #    *  (`nil`) indicating no credentials