google-cloud-ai_platform-v1 1.41.0 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506cc0abcdbb4ee5a2fc143c9c4f6af8f7e0780bc2dc59f74a03d005b802e328
-  data.tar.gz: f7766553bcf148f0ac56110031a6a18b612b002f2221666959d6c9979e03a961
+  metadata.gz: 5ef7b57b0db627d65dd8361a39ebb6f62a61ba8ef8ad0a815d2c8ec2c3e4ac36
+  data.tar.gz: 1fdf372a40258ad9529888ffab4df00c992b90380d72d4c01d0c178fe182e4a4
 SHA512:
-  metadata.gz: 521f838c36e863b471cc44fbdcfc15ec703a007f36a715abe055dba00235c3a3d02f665ed18e48b04b8fc0c5389c11eeeb8dbc3634a4f89d43592ff399375763
-  data.tar.gz: 763687c43fe0606ab802ea8e560b0415ac54ee5ea21fcf6b6e0cbb532492d54c21220b903b293d2672ff0a1379efef94720de6dd06261cb5f2f62632a9b16314
+  metadata.gz: 96c7248f54bb63a4217644ae920d1355b77e87b90eb791407960cc282771592e8a49d5b0cf8ac9b9716b3311e672a30d92059684a916a068b917e648645189e5
+  data.tar.gz: 7f0569ebdb4498f4195ad613818bf8580c42724515a129458395c8dd671488b6e369c7eaf4e8f04d35584063db517d69943b0854b6a475d41ec0a2c588abc847

data/lib/google/cloud/ai_platform/v1/reasoning_engine_execution_service/client.rb

@@ -151,6 +151,13 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @operations_client = Operations.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+                config.universe_domain = @config.universe_domain
+              end
+
               @reasoning_engine_execution_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Stub,
                 credentials: credentials,
@@ -190,6 +197,13 @@ module Google
               end
             end
 
+            ##
+            # Get the associated client for long-running operations.
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Operations]
+            #
+            attr_reader :operations_client
+
             ##
             # Get the associated client for mix-in of the Locations.
             #
@@ -404,6 +418,198 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Async query using a reasoning engine.
+            #
+            # @overload async_query_reasoning_engine(request, options = nil)
+            #   Pass arguments to `async_query_reasoning_engine` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest, ::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 async_query_reasoning_engine(name: nil, input_gcs_uri: nil, output_gcs_uri: nil)
+            #   Pass arguments to `async_query_reasoning_engine` 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 name of the ReasoningEngine resource to use.
+            #     Format:
+            #     `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+            #   @param input_gcs_uri [::String]
+            #     Optional. Input Cloud Storage URI for the Async query.
+            #   @param output_gcs_uri [::String]
+            #     Optional. Output Cloud Storage URI for the Async query.
+            #
+            # @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/ai_platform/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest.new
+            #
+            #   # Call the async_query_reasoning_engine method.
+            #   result = client.async_query_reasoning_engine 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 async_query_reasoning_engine request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest
+
+              # 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.async_query_reasoning_engine.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::AIPlatform::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.async_query_reasoning_engine.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.async_query_reasoning_engine.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @reasoning_engine_execution_service_stub.call_rpc :async_query_reasoning_engine, 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
+
+            ##
+            # Cancels an AsyncQueryReasoningEngine operation.
+            #
+            # @overload cancel_async_query_reasoning_engine(request, options = nil)
+            #   Pass arguments to `cancel_async_query_reasoning_engine` via a request object, either of type
+            #   {::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest, ::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 cancel_async_query_reasoning_engine(name: nil, operation_name: nil)
+            #   Pass arguments to `cancel_async_query_reasoning_engine` 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 name of the ReasoningEngine resource to use.
+            #     Format:
+            #     `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`
+            #   @param operation_name [::String]
+            #     Required. The name of the longrunning operation returned from
+            #     AsyncQueryReasoningEngine.
+            #     Format:
+            #     `projects/{project}/locations/{location}/operations/{operation}`
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/ai_platform/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest.new
+            #
+            #   # Call the cancel_async_query_reasoning_engine method.
+            #   result = client.cancel_async_query_reasoning_engine request
+            #
+            #   # The returned object is of type Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse.
+            #   p result
+            #
+            def cancel_async_query_reasoning_engine request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest
+
+              # 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.cancel_async_query_reasoning_engine.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::AIPlatform::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.cancel_async_query_reasoning_engine.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.cancel_async_query_reasoning_engine.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @reasoning_engine_execution_service_stub.call_rpc :cancel_async_query_reasoning_engine, 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 ReasoningEngineExecutionService API.
             #
@@ -597,6 +803,16 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :stream_query_reasoning_engine
+                ##
+                # RPC-specific configuration for `async_query_reasoning_engine`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :async_query_reasoning_engine
+                ##
+                # RPC-specific configuration for `cancel_async_query_reasoning_engine`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :cancel_async_query_reasoning_engine
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -604,6 +820,10 @@ module Google
                   @query_reasoning_engine = ::Gapic::Config::Method.new query_reasoning_engine_config
                   stream_query_reasoning_engine_config = parent_rpcs.stream_query_reasoning_engine if parent_rpcs.respond_to? :stream_query_reasoning_engine
                   @stream_query_reasoning_engine = ::Gapic::Config::Method.new stream_query_reasoning_engine_config
+                  async_query_reasoning_engine_config = parent_rpcs.async_query_reasoning_engine if parent_rpcs.respond_to? :async_query_reasoning_engine
+                  @async_query_reasoning_engine = ::Gapic::Config::Method.new async_query_reasoning_engine_config
+                  cancel_async_query_reasoning_engine_config = parent_rpcs.cancel_async_query_reasoning_engine if parent_rpcs.respond_to? :cancel_async_query_reasoning_engine
+                  @cancel_async_query_reasoning_engine = ::Gapic::Config::Method.new cancel_async_query_reasoning_engine_config
 
                   yield self if block_given?
                 end