google-cloud-alloy_db-v1 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3a39856e69a6f5db297ee6d22cb036301aff82e6eda24e811bdbfe06587921b
-  data.tar.gz: c759eacfd184c0e4a210514d79af8b7780de34302b0732ec4802b71d22bf6c87
+  metadata.gz: d7c6a18ec347a85af5b63a2163c7243624167d75f450453c1975bb0345742304
+  data.tar.gz: f42c73df071937d5061b7bfda28e64e13ec0e22ed4d9b378818b27ebcadafca7
 SHA512:
-  metadata.gz: ed32413a0724375ed67dca70b264eb742bfa34876c4a80a739269264db4948b9c85c8753d5671efb4cd28eabdf592d5556575a214576baf2ce859553cf3146f8
-  data.tar.gz: 39e054f379cc3d7b44b280f743186140172a758911c87cc1e2a20e69a4a5b5be1e20ef2033673d7580ef54a84d20973701cf36d8cbdc249b72e373b5c8f506f4
+  metadata.gz: fd4b8dd71d123a16e280042ec401628b93a3be72ba0cbdf6c20acdfae6e68b7f408cdac6a48990863729f50386e08f8fb22731202cd014a2458bd269ae1cec94
+  data.tar.gz: 75fb8431c846f936dbc37b8a123661a71eb6dea9df34ecf5b8111e4bd2e04052f0ead8819919125af85eeedb05fdfb67b1e150e5cd8a19439336fcd7cf3d9fa8

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the AlloyDB V1 API
 
-AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
+AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.  AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
 
 AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
 

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

@@ -706,6 +706,353 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Exports data from the cluster.
+            # Imperative only.
+            #
+            # @overload export_cluster(request, options = nil)
+            #   Pass arguments to `export_cluster` via a request object, either of type
+            #   {::Google::Cloud::AlloyDB::V1::ExportClusterRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AlloyDB::V1::ExportClusterRequest, ::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 export_cluster(gcs_destination: nil, csv_export_options: nil, sql_export_options: nil, name: nil, database: nil)
+            #   Pass arguments to `export_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 gcs_destination [::Google::Cloud::AlloyDB::V1::GcsDestination, ::Hash]
+            #     Required. Option to export data to cloud storage.
+            #   @param csv_export_options [::Google::Cloud::AlloyDB::V1::ExportClusterRequest::CsvExportOptions, ::Hash]
+            #     Options for exporting data in CSV format. Required field to be set for
+            #     CSV file type.
+            #
+            #     Note: The following fields are mutually exclusive: `csv_export_options`, `sql_export_options`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+            #   @param sql_export_options [::Google::Cloud::AlloyDB::V1::ExportClusterRequest::SqlExportOptions, ::Hash]
+            #     Options for exporting data in SQL format. Required field to be set for
+            #     SQL file type.
+            #
+            #     Note: The following fields are mutually exclusive: `sql_export_options`, `csv_export_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 database [::String]
+            #     Required. Name of the database where the export command will be executed.
+            #     Note - Value provided should be the same as expected from
+            #     `SELECT current_database();` 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/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AlloyDB::V1::ExportClusterRequest.new
+            #
+            #   # Call the export_cluster method.
+            #   result = client.export_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 export_cluster request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::ExportClusterRequest
+
+              # 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.export_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::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.export_cluster.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.export_cluster.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @alloy_db_admin_stub.call_rpc :export_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
+
+            ##
+            # 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::V1::ImportClusterRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AlloyDB::V1::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::V1::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::V1::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/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AlloyDB::V1::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::V1::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::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.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.
+            #
+            # @overload upgrade_cluster(request, options = nil)
+            #   Pass arguments to `upgrade_cluster` via a request object, either of type
+            #   {::Google::Cloud::AlloyDB::V1::UpgradeClusterRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AlloyDB::V1::UpgradeClusterRequest, ::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 upgrade_cluster(name: nil, version: nil, request_id: nil, validate_only: nil, etag: nil)
+            #   Pass arguments to `upgrade_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 name [::String]
+            #     Required. The resource name of the cluster.
+            #   @param version [::Google::Cloud::AlloyDB::V1::DatabaseVersion]
+            #     Required. The version the cluster is going to be upgraded to.
+            #   @param request_id [::String]
+            #     Optional. An optional request ID to identify requests. Specify a unique
+            #     request ID so that if you must retry your request, the server ignores the
+            #     request if it has already been completed. The server guarantees that for at
+            #     least 60 minutes since the first request.
+            #
+            #     For example, consider a situation where you make an initial request and
+            #     the request times out. If you make the request again with the same request
+            #     ID, the server can check if the original operation with the same request ID
+            #     was received, and if so, ignores the second request. This prevents
+            #     clients from accidentally creating duplicate commitments.
+            #
+            #     The request ID must be a valid UUID with the exception that zero UUID is
+            #     not supported (00000000-0000-0000-0000-000000000000).
+            #   @param validate_only [::Boolean]
+            #     Optional. If set, performs request validation, for example, permission
+            #     checks and any other type of validation, but does not actually execute the
+            #     create request.
+            #   @param etag [::String]
+            #     Optional. The current etag of the Cluster.
+            #     If an etag is provided and does not match the current etag of the Cluster,
+            #     upgrade will be blocked and an ABORTED error will be returned.
+            #
+            # @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/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AlloyDB::V1::AlloyDBAdmin::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AlloyDB::V1::UpgradeClusterRequest.new
+            #
+            #   # Call the upgrade_cluster method.
+            #   result = client.upgrade_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 upgrade_cluster request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AlloyDB::V1::UpgradeClusterRequest
+
+              # 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.upgrade_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::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.upgrade_cluster.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.upgrade_cluster.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @alloy_db_admin_stub.call_rpc :upgrade_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
+
             ##
             # Deletes a single Cluster.
             #
@@ -3086,7 +3433,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).
@@ -3104,6 +3451,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::V1::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::V1::SupportedDatabaseFlag>]
@@ -3223,9 +3573,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::V1::GenerateClientCertificateResponse]
@@ -4186,6 +4536,21 @@ module Google
                 #
                 attr_reader :update_cluster
                 ##
+                # RPC-specific configuration for `export_cluster`
+                # @return [::Gapic::Config::Method]
+                #
+                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]
+                #
+                attr_reader :upgrade_cluster
+                ##
                 # RPC-specific configuration for `delete_cluster`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4346,6 +4711,12 @@ module Google
                   @create_cluster = ::Gapic::Config::Method.new create_cluster_config
                   update_cluster_config = parent_rpcs.update_cluster if parent_rpcs.respond_to? :update_cluster
                   @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
                   @delete_cluster = ::Gapic::Config::Method.new delete_cluster_config
                   promote_cluster_config = parent_rpcs.promote_cluster if parent_rpcs.respond_to? :promote_cluster