google-cloud-sql-v1 0.8.0 → 0.9.0

data/lib/google/cloud/sql/v1/sql_instances_service/client.rb

@@ -2324,6 +2324,194 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Starts a Cloud SQL instance.
+            #
+            # @overload start(request, options = nil)
+            #   Pass arguments to `start` via a request object, either of type
+            #   {::Google::Cloud::Sql::V1::SqlInstancesStartRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Sql::V1::SqlInstancesStartRequest, ::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 start(instance: nil, project: nil, location: nil)
+            #   Pass arguments to `start` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param instance [::String]
+            #     Required. Cloud SQL instance ID. This does not include the project ID.
+            #   @param project [::String]
+            #     Required. Project ID of the project that contains the instance to be
+            #     started.
+            #   @param location [::String]
+            #     Optional. The region of the Cloud SQL instance, for example `us-central1`.
+            #     If omitted, the region is determined from the instance.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Sql::V1::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Sql::V1::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/sql/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Sql::V1::SqlInstancesService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Sql::V1::SqlInstancesStartRequest.new
+            #
+            #   # Call the start method.
+            #   result = client.start request
+            #
+            #   # The returned object is of type Google::Cloud::Sql::V1::Operation.
+            #   p result
+            #
+            def start request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlInstancesStartRequest
+
+              # 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.start.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::Sql::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.project
+                header_params["project"] = request.project
+              end
+              if request.instance
+                header_params["instance"] = request.instance
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.start.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.start.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @sql_instances_service_stub.call_rpc :start, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Stops a Cloud SQL instance.
+            #
+            # @overload stop(request, options = nil)
+            #   Pass arguments to `stop` via a request object, either of type
+            #   {::Google::Cloud::Sql::V1::SqlInstancesStopRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Sql::V1::SqlInstancesStopRequest, ::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 stop(instance: nil, project: nil, location: nil)
+            #   Pass arguments to `stop` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param instance [::String]
+            #     Required. Cloud SQL instance ID. This does not include the project ID.
+            #   @param project [::String]
+            #     Required. Project ID of the project that contains the instance to be
+            #     stopped.
+            #   @param location [::String]
+            #     Optional. The region of the Cloud SQL instance, for example `us-central1`.
+            #     If omitted, the region is determined from the instance.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Sql::V1::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Sql::V1::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/sql/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Sql::V1::SqlInstancesService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Sql::V1::SqlInstancesStopRequest.new
+            #
+            #   # Call the stop method.
+            #   result = client.stop request
+            #
+            #   # The returned object is of type Google::Cloud::Sql::V1::Operation.
+            #   p result
+            #
+            def stop request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlInstancesStopRequest
+
+              # 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.stop.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::Sql::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.project
+                header_params["project"] = request.project
+              end
+              if request.instance
+                header_params["instance"] = request.instance
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.stop.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.stop.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @sql_instances_service_stub.call_rpc :stop, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Restores a backup of a Cloud SQL instance. Using this operation might cause
             # your instance to restart.
@@ -3859,6 +4047,100 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Execute SQL statements in read-only mode.
+            #
+            # @overload execute_sql_read_only(request, options = nil)
+            #   Pass arguments to `execute_sql_read_only` via a request object, either of type
+            #   {::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyRequest, ::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 execute_sql_read_only(instance: nil, project: nil, body: nil, location: nil)
+            #   Pass arguments to `execute_sql_read_only` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param instance [::String]
+            #     Required. Database instance ID. This does not include the project ID.
+            #   @param project [::String]
+            #     Required. Project ID of the project that contains the instance.
+            #   @param body [::Google::Cloud::Sql::V1::ExecuteSqlReadOnlyPayload, ::Hash]
+            #     Required. The request body.
+            #   @param location [::String]
+            #     Optional. Region of the Cloud SQL instance.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/sql/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Sql::V1::SqlInstancesService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyRequest.new
+            #
+            #   # Call the execute_sql_read_only method.
+            #   result = client.execute_sql_read_only request
+            #
+            #   # The returned object is of type Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyResponse.
+            #   p result
+            #
+            def execute_sql_read_only request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlInstancesExecuteSqlReadOnlyRequest
+
+              # 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.execute_sql_read_only.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::Sql::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.project
+                header_params["project"] = request.project
+              end
+              if request.instance
+                header_params["instance"] = request.instance
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.execute_sql_read_only.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.execute_sql_read_only.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @sql_instances_service_stub.call_rpc :execute_sql_read_only, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Execute SQL statements.
             #
@@ -4331,6 +4613,105 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Repairs and recreates networking resources for a Cloud SQL instance. For
+            # Private Service Connect (PSC), this operation recreates PSC DNS write
+            # endpoints on specified VPC networks and reconciles Private Service Connect
+            # connectivity infrastructure for the instance.
+            #
+            # @overload reconcile_networking(request, options = nil)
+            #   Pass arguments to `reconcile_networking` via a request object, either of type
+            #   {::Google::Cloud::Sql::V1::SqlInstancesReconcileNetworkingRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Sql::V1::SqlInstancesReconcileNetworkingRequest, ::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 reconcile_networking(instance: nil, project: nil, psc_dns: nil, location: nil)
+            #   Pass arguments to `reconcile_networking` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param instance [::String]
+            #     Required. Cloud SQL instance ID.
+            #   @param project [::String]
+            #     Required. Project ID of the project that contains the instance.
+            #   @param psc_dns [::Google::Cloud::Sql::V1::PscDnsReconcileNetworkingRequest, ::Hash]
+            #     Request to recreate Private Service Connect DNS write endpoints and
+            #     reconcile Private Service Connect connectivity infrastructure for the
+            #     instance.
+            #   @param location [::String]
+            #     Optional. Region of the Cloud SQL instance.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Sql::V1::Operation]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Sql::V1::Operation]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/sql/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Sql::V1::SqlInstancesService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Sql::V1::SqlInstancesReconcileNetworkingRequest.new
+            #
+            #   # Call the reconcile_networking method.
+            #   result = client.reconcile_networking request
+            #
+            #   # The returned object is of type Google::Cloud::Sql::V1::Operation.
+            #   p result
+            #
+            def reconcile_networking request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Sql::V1::SqlInstancesReconcileNetworkingRequest
+
+              # 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.reconcile_networking.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::Sql::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.project
+                header_params["project"] = request.project
+              end
+              if request.instance
+                header_params["instance"] = request.instance
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.reconcile_networking.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.reconcile_networking.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @sql_instances_service_stub.call_rpc :reconcile_networking, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the SqlInstancesService API.
             #
@@ -4627,6 +5008,16 @@ module Google
                 #
                 attr_reader :restart
                 ##
+                # RPC-specific configuration for `start`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :start
+                ##
+                # RPC-specific configuration for `stop`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :stop
+                ##
                 # RPC-specific configuration for `restore_backup`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4707,6 +5098,11 @@ module Google
                 #
                 attr_reader :get_latest_recovery_time
                 ##
+                # RPC-specific configuration for `execute_sql_read_only`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :execute_sql_read_only
+                ##
                 # RPC-specific configuration for `execute_sql`
                 # @return [::Gapic::Config::Method]
                 #
@@ -4731,6 +5127,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :point_in_time_restore
+                ##
+                # RPC-specific configuration for `reconcile_networking`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :reconcile_networking
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -4778,6 +5179,10 @@ module Google
                   @reset_ssl_config = ::Gapic::Config::Method.new reset_ssl_config_config
                   restart_config = parent_rpcs.restart if parent_rpcs.respond_to? :restart
                   @restart = ::Gapic::Config::Method.new restart_config
+                  start_config = parent_rpcs.start if parent_rpcs.respond_to? :start
+                  @start = ::Gapic::Config::Method.new start_config
+                  stop_config = parent_rpcs.stop if parent_rpcs.respond_to? :stop
+                  @stop = ::Gapic::Config::Method.new stop_config
                   restore_backup_config = parent_rpcs.restore_backup if parent_rpcs.respond_to? :restore_backup
                   @restore_backup = ::Gapic::Config::Method.new restore_backup_config
                   rotate_server_ca_config = parent_rpcs.rotate_server_ca if parent_rpcs.respond_to? :rotate_server_ca
@@ -4810,6 +5215,8 @@ module Google
                   @reset_replica_size = ::Gapic::Config::Method.new reset_replica_size_config
                   get_latest_recovery_time_config = parent_rpcs.get_latest_recovery_time if parent_rpcs.respond_to? :get_latest_recovery_time
                   @get_latest_recovery_time = ::Gapic::Config::Method.new get_latest_recovery_time_config
+                  execute_sql_read_only_config = parent_rpcs.execute_sql_read_only if parent_rpcs.respond_to? :execute_sql_read_only
+                  @execute_sql_read_only = ::Gapic::Config::Method.new execute_sql_read_only_config
                   execute_sql_config = parent_rpcs.execute_sql if parent_rpcs.respond_to? :execute_sql
                   @execute_sql = ::Gapic::Config::Method.new execute_sql_config
                   acquire_ssrs_lease_config = parent_rpcs.acquire_ssrs_lease if parent_rpcs.respond_to? :acquire_ssrs_lease
@@ -4820,6 +5227,8 @@ module Google
                   @pre_check_major_version_upgrade = ::Gapic::Config::Method.new pre_check_major_version_upgrade_config
                   point_in_time_restore_config = parent_rpcs.point_in_time_restore if parent_rpcs.respond_to? :point_in_time_restore
                   @point_in_time_restore = ::Gapic::Config::Method.new point_in_time_restore_config
+                  reconcile_networking_config = parent_rpcs.reconcile_networking if parent_rpcs.respond_to? :reconcile_networking
+                  @reconcile_networking = ::Gapic::Config::Method.new reconcile_networking_config
 
                   yield self if block_given?
                 end

data/lib/google/cloud/sql/v1/sql_instances_service/paths.rb

@@ -113,6 +113,23 @@ module Google
               "projects/#{project}/locations/#{location}/keyRings/#{key_ring}/cryptoKeys/#{crypto_key}/cryptoKeyVersions/#{crypto_key_version}"
             end
 
+            ##
+            # Create a fully-qualified Instance resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/instances/{instance}`
+            #
+            # @param project [String]
+            # @param instance [String]
+            #
+            # @return [::String]
+            def instance_path project:, instance:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/instances/#{instance}"
+            end
+
             ##
             # Create a fully-qualified Network resource string.
             #