google-cloud-alloy_db-v1beta 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c996a3965af1b98b7113aa71e15684537358f6160594d30df947c319a74e07b
-  data.tar.gz: 4f4bb5c0d7c87c00404c590db48824b9d8b5bda4bbd6c5e14fd78fb2d8661ab0
+  metadata.gz: 8b21ba7f5c49588187d7f750051b1699a41eddf26d1e0a06e6d6d0c7537ae068
+  data.tar.gz: d146a45c45b4effe6c71ee62dcb699b5757f1bb110217bbc7775473bffa8a7be
 SHA512:
-  metadata.gz: dc1a8c8c0b208090ec02156c795e566a99a858c1df5d633ce982c226085901bd8429199cf928bb69d04f765dae23119dcb38c506f88c3496b4241d9561dbf951
-  data.tar.gz: 79fb60eaf21ed7ebc751a6d257085a396c29dd244ba4681c16f3f584450397bb5f99c63fc3b3b39bb6bcc0a439d1d39467be70d5ab89d0fae3f4f782e26981d9
+  metadata.gz: 62ec0bd4679637caff2a8eac258f46dc5057de127b4f6f8d91b2d862ac599a6e65f3e5914ca5e76774b428441439b6c2b33988cb9add039ed18856be68e5ffbf
+  data.tar.gz: 67b05502f84a7237da360e4a49cbb815209040651e19b0f322b92e275082c5fdbc5742de451ec1eec1dbe4d8dfc291a80a3c29f592ae69966a3a3b50e9fb14cb

data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/client.rb

@@ -832,6 +832,123 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Imports data to the cluster.
+            # Imperative only.
+            #
+            # @overload import_cluster(request, options = nil)
+            #   Pass arguments to `import_cluster` via a request object, either of type
+            #   {::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest, ::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 import_cluster(sql_import_options: nil, csv_import_options: nil, name: nil, gcs_uri: nil, database: nil, user: nil)
+            #   Pass arguments to `import_cluster` 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 sql_import_options [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest::SqlImportOptions, ::Hash]
+            #     Options for importing data in SQL format.
+            #
+            #     Note: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            #   @param csv_import_options [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest::CsvImportOptions, ::Hash]
+            #     Options for importing data in CSV format.
+            #
+            #     Note: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            #   @param name [::String]
+            #     Required. The resource name of the cluster.
+            #   @param gcs_uri [::String]
+            #     Required. The path to the file in Google Cloud Storage where the source
+            #     file for import will be stored. The URI is in the form
+            #     `gs://bucketName/fileName`.
+            #   @param database [::String]
+            #     Optional. Name of the database to which the import will be done.
+            #     For import from SQL file, this is required only if the file does not
+            #     specify a database.
+            #     Note - Value provided should be the same as expected from `SELECT
+            #     current_database();` and NOT as a resource reference.
+            #   @param user [::String]
+            #     Optional. Database user to be used for importing the data.
+            #     Note - Value provided should be the same as expected from
+            #     `SELECT current_user;` and NOT as a resource reference.
+            #
+            # @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/alloy_db/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AlloyDB::V1beta::ImportClusterRequest.new
+            #
+            #   # Call the import_cluster method.
+            #   result = client.import_cluster 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 import_cluster request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest
+
+              # 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.import_cluster.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::AlloyDB::V1beta::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.import_cluster.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.import_cluster.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @alloy_db_admin_stub.call_rpc :import_cluster, request, options: options do |response, operation|
+                response = ::Gapic::Operation.new response, @operations_client, options: options
+                yield response, operation if block_given?
+                throw :response, response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Upgrades a single Cluster.
             # Imperative only.
@@ -3331,7 +3448,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload list_supported_database_flags(parent: nil, page_size: nil, page_token: nil)
+            # @overload list_supported_database_flags(parent: nil, page_size: nil, page_token: nil, scope: nil)
             #   Pass arguments to `list_supported_database_flags` 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).
@@ -3349,6 +3466,9 @@ module Google
             #     If unspecified, server will pick an appropriate default.
             #   @param page_token [::String]
             #     A token identifying a page of results the server should return.
+            #   @param scope [::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag::Scope]
+            #     Optional. The scope for which supported flags are requested. If not
+            #     specified, default is DATABASE.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag>]
@@ -3471,9 +3591,9 @@ module Google
             #   @param public_key [::String]
             #     Optional. The public key from the client.
             #   @param use_metadata_exchange [::Boolean]
-            #     Optional. An optional hint to the endpoint to generate a client
-            #     ceritificate that can be used by AlloyDB connectors to exchange additional
-            #     metadata with the server after TLS handshake.
+            #     Optional. An optional hint to the endpoint to generate a client certificate
+            #     that can be used by AlloyDB connectors to exchange additional metadata with
+            #     the server after TLS handshake.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
@@ -4439,6 +4559,11 @@ module Google
                 #
                 attr_reader :export_cluster
                 ##
+                # RPC-specific configuration for `import_cluster`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :import_cluster
+                ##
                 # RPC-specific configuration for `upgrade_cluster`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4606,6 +4731,8 @@ module Google
                   @update_cluster = ::Gapic::Config::Method.new update_cluster_config
                   export_cluster_config = parent_rpcs.export_cluster if parent_rpcs.respond_to? :export_cluster
                   @export_cluster = ::Gapic::Config::Method.new export_cluster_config
+                  import_cluster_config = parent_rpcs.import_cluster if parent_rpcs.respond_to? :import_cluster
+                  @import_cluster = ::Gapic::Config::Method.new import_cluster_config
                   upgrade_cluster_config = parent_rpcs.upgrade_cluster if parent_rpcs.respond_to? :upgrade_cluster
                   @upgrade_cluster = ::Gapic::Config::Method.new upgrade_cluster_config
                   delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster

data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/client.rb

@@ -791,6 +791,116 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Imports data to the cluster.
+              # Imperative only.
+              #
+              # @overload import_cluster(request, options = nil)
+              #   Pass arguments to `import_cluster` via a request object, either of type
+              #   {::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest, ::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 import_cluster(sql_import_options: nil, csv_import_options: nil, name: nil, gcs_uri: nil, database: nil, user: nil)
+              #   Pass arguments to `import_cluster` 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 sql_import_options [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest::SqlImportOptions, ::Hash]
+              #     Options for importing data in SQL format.
+              #
+              #     Note: The following fields are mutually exclusive: `sql_import_options`, `csv_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+              #   @param csv_import_options [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest::CsvImportOptions, ::Hash]
+              #     Options for importing data in CSV format.
+              #
+              #     Note: The following fields are mutually exclusive: `csv_import_options`, `sql_import_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+              #   @param name [::String]
+              #     Required. The resource name of the cluster.
+              #   @param gcs_uri [::String]
+              #     Required. The path to the file in Google Cloud Storage where the source
+              #     file for import will be stored. The URI is in the form
+              #     `gs://bucketName/fileName`.
+              #   @param database [::String]
+              #     Optional. Name of the database to which the import will be done.
+              #     For import from SQL file, this is required only if the file does not
+              #     specify a database.
+              #     Note - Value provided should be the same as expected from `SELECT
+              #     current_database();` and NOT as a resource reference.
+              #   @param user [::String]
+              #     Optional. Database user to be used for importing the data.
+              #     Note - Value provided should be the same as expected from
+              #     `SELECT current_user;` and NOT as a resource reference.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/alloy_db/v1beta"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::AlloyDB::V1beta::AlloyDBAdmin::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::AlloyDB::V1beta::ImportClusterRequest.new
+              #
+              #   # Call the import_cluster method.
+              #   result = client.import_cluster 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 import_cluster request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest
+
+                # 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
+                call_metadata = @config.rpcs.import_cluster.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_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::AlloyDB::V1beta::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.import_cluster.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.import_cluster.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @alloy_db_admin_stub.import_cluster request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  throw :response, result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Upgrades a single Cluster.
               # Imperative only.
@@ -3136,7 +3246,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload list_supported_database_flags(parent: nil, page_size: nil, page_token: nil)
+              # @overload list_supported_database_flags(parent: nil, page_size: nil, page_token: nil, scope: nil)
               #   Pass arguments to `list_supported_database_flags` 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).
@@ -3154,6 +3264,9 @@ module Google
               #     If unspecified, server will pick an appropriate default.
               #   @param page_token [::String]
               #     A token identifying a page of results the server should return.
+              #   @param scope [::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag::Scope]
+              #     Optional. The scope for which supported flags are requested. If not
+              #     specified, default is DATABASE.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag>]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -3269,9 +3382,9 @@ module Google
               #   @param public_key [::String]
               #     Optional. The public key from the client.
               #   @param use_metadata_exchange [::Boolean]
-              #     Optional. An optional hint to the endpoint to generate a client
-              #     ceritificate that can be used by AlloyDB connectors to exchange additional
-              #     metadata with the server after TLS handshake.
+              #     Optional. An optional hint to the endpoint to generate a client certificate
+              #     that can be used by AlloyDB connectors to exchange additional metadata with
+              #     the server after TLS handshake.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::AlloyDB::V1beta::GenerateClientCertificateResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -4168,6 +4281,11 @@ module Google
                   #
                   attr_reader :export_cluster
                   ##
+                  # RPC-specific configuration for `import_cluster`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :import_cluster
+                  ##
                   # RPC-specific configuration for `upgrade_cluster`
                   # @return [::Gapic::Config::Method]
                   #
@@ -4335,6 +4453,8 @@ module Google
                     @update_cluster = ::Gapic::Config::Method.new update_cluster_config
                     export_cluster_config = parent_rpcs.export_cluster if parent_rpcs.respond_to? :export_cluster
                     @export_cluster = ::Gapic::Config::Method.new export_cluster_config
+                    import_cluster_config = parent_rpcs.import_cluster if parent_rpcs.respond_to? :import_cluster
+                    @import_cluster = ::Gapic::Config::Method.new import_cluster_config
                     upgrade_cluster_config = parent_rpcs.upgrade_cluster if parent_rpcs.respond_to? :upgrade_cluster
                     @upgrade_cluster = ::Gapic::Config::Method.new upgrade_cluster_config
                     delete_cluster_config = parent_rpcs.delete_cluster if parent_rpcs.respond_to? :delete_cluster

data/lib/google/cloud/alloy_db/v1beta/alloy_db_admin/rest/service_stub.rb

@@ -273,6 +273,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the import_cluster REST call
+              #
+              # @param request_pb [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def import_cluster request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_import_cluster_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "import_cluster",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # Baseline implementation for the upgrade_cluster REST call
               #
@@ -1621,6 +1661,28 @@ module Google
                 transcoder.transcode request_pb
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the import_cluster REST call
+              #
+              # @param request_pb [::Google::Cloud::AlloyDB::V1beta::ImportClusterRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_import_cluster_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1beta/{name}:import",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/clusters/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #