# frozen_string_literal: true # Copyright 2024 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/discoveryengine/v1beta/engine_service_pb" require "google/cloud/location" module Google module Cloud module DiscoveryEngine module V1beta module EngineService ## # Client for the EngineService service. # # Service for managing {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} # configuration. # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "discoveryengine.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :engine_service_stub ## # Configure the EngineService Client class. # # See {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all EngineService clients # ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "DiscoveryEngine", "V1beta"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config end yield @configure if block_given? @configure end ## # Configure the EngineService Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # The effective universe domain # # @return [String] # def universe_domain @engine_service_stub.universe_domain end ## # Create a new EngineService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the EngineService client. # @yieldparam config [Client::Configuration] # def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/discoveryengine/v1beta/engine_service_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @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 @engine_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @engine_service_stub.endpoint config.universe_domain = @engine_service_stub.universe_domain end end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client # Service calls ## # Creates a {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}. # # @overload create_engine(request, options = nil) # Pass arguments to `create_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest, ::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 create_engine(parent: nil, engine: nil, engine_id: nil) # Pass arguments to `create_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 parent [::String] # Required. The parent resource name, such as # `projects/{project}/locations/{location}/collections/{collection}`. # @param engine [::Google::Cloud::DiscoveryEngine::V1beta::Engine, ::Hash] # Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to # create. # @param engine_id [::String] # Required. The ID to use for the # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, which will become the # final component of the # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}'s resource name. # # This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) # standard with a length limit of 63 characters. Otherwise, an # INVALID_ARGUMENT error is 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/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest.new # # # Call the create_engine method. # result = client.create_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 create_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::CreateEngineRequest # 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.create_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::DiscoveryEngine::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.parent header_params["parent"] = request.parent 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.create_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.create_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :create_engine, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}. # # @overload delete_engine(request, options = nil) # Pass arguments to `delete_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::DeleteEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::DeleteEngineRequest, ::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 delete_engine(name: nil) # Pass arguments to `delete_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. Full resource name of # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, such as # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. # # If the caller does not have permission to delete the # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, regardless of whether # or not it exists, a PERMISSION_DENIED error is returned. # # If the {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to delete does # not exist, a NOT_FOUND error is 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/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::DeleteEngineRequest.new # # # Call the delete_engine method. # result = client.delete_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 delete_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::DeleteEngineRequest # 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.delete_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::DiscoveryEngine::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.delete_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :delete_engine, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates an {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} # # @overload update_engine(request, options = nil) # Pass arguments to `update_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::UpdateEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::UpdateEngineRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_engine(engine: nil, update_mask: nil) # Pass arguments to `update_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 engine [::Google::Cloud::DiscoveryEngine::V1beta::Engine, ::Hash] # Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to # update. # # If the caller does not have permission to update the # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, regardless of whether # or not it exists, a PERMISSION_DENIED error is returned. # # If the {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to update does # not exist, a NOT_FOUND error is returned. # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Indicates which fields in the provided # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} to update. # # If an unsupported or unknown field is provided, an INVALID_ARGUMENT error # is returned. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::UpdateEngineRequest.new # # # Call the update_engine method. # result = client.update_engine request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine. # p result # def update_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::UpdateEngineRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_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::DiscoveryEngine::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.engine&.name header_params["engine.name"] = request.engine.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.update_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :update_engine, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets a {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}. # # @overload get_engine(request, options = nil) # Pass arguments to `get_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::GetEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::GetEngineRequest, ::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 get_engine(name: nil) # Pass arguments to `get_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. Full resource name of # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}, such as # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::GetEngineRequest.new # # # Call the get_engine method. # result = client.get_engine request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine. # p result # def get_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::GetEngineRequest # 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.get_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::DiscoveryEngine::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.get_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.get_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :get_engine, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Lists all the {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine}s # associated with the project. # # @overload list_engines(request, options = nil) # Pass arguments to `list_engines` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesRequest, ::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 list_engines(parent: nil, page_size: nil, page_token: nil, filter: nil) # Pass arguments to `list_engines` 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 parent [::String] # Required. The parent resource name, such as # `projects/{project}/locations/{location}/collections/{collection_id}`. # @param page_size [::Integer] # Optional. Not supported. # @param page_token [::String] # Optional. Not supported. # @param filter [::String] # Optional. Filter by solution type. For example: # solution_type=SOLUTION_TYPE_SEARCH # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Engine>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Engine>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::ListEnginesRequest.new # # # Call the list_engines method. # result = client.list_engines request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::Engine. # p item # end # def list_engines request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ListEnginesRequest # 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.list_engines.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::DiscoveryEngine::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.parent header_params["parent"] = request.parent 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.list_engines.timeout, metadata: metadata, retry_policy: @config.rpcs.list_engines.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :list_engines, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @engine_service_stub, :list_engines, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Pauses the training of an existing engine. Only applicable if # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}. # # @overload pause_engine(request, options = nil) # Pass arguments to `pause_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest, ::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 pause_engine(name: nil) # Pass arguments to `pause_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 engine to pause. # Format: # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest.new # # # Call the pause_engine method. # result = client.pause_engine request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine. # p result # def pause_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::PauseEngineRequest # 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.pause_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::DiscoveryEngine::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.pause_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.pause_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :pause_engine, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Resumes the training of an existing engine. Only applicable if # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}. # # @overload resume_engine(request, options = nil) # Pass arguments to `resume_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest, ::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 resume_engine(name: nil) # Pass arguments to `resume_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 engine to resume. # Format: # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest.new # # # Call the resume_engine method. # result = client.resume_engine request # # # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Engine. # p result # def resume_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::ResumeEngineRequest # 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.resume_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::DiscoveryEngine::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.resume_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.resume_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :resume_engine, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Tunes an existing engine. Only applicable if # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType SolutionType} is # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}. # # @overload tune_engine(request, options = nil) # Pass arguments to `tune_engine` via a request object, either of type # {::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest} or an equivalent Hash. # # @param request [::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest, ::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 tune_engine(name: nil) # Pass arguments to `tune_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 resource name of the engine to tune. # Format: # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` # # @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/discovery_engine/v1beta" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest.new # # # Call the tune_engine method. # result = client.tune_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 tune_engine request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1beta::TuneEngineRequest # 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.tune_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::DiscoveryEngine::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.tune_engine.timeout, metadata: metadata, retry_policy: @config.rpcs.tune_engine.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @engine_service_stub.call_rpc :tune_engine, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the EngineService API. # # This class represents the configuration for EngineService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # create_engine to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.create_engine.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.create_engine.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "discoveryengine.googleapis.com" config_attr :endpoint, nil, ::String, nil config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the EngineService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `create_engine` # @return [::Gapic::Config::Method] # attr_reader :create_engine ## # RPC-specific configuration for `delete_engine` # @return [::Gapic::Config::Method] # attr_reader :delete_engine ## # RPC-specific configuration for `update_engine` # @return [::Gapic::Config::Method] # attr_reader :update_engine ## # RPC-specific configuration for `get_engine` # @return [::Gapic::Config::Method] # attr_reader :get_engine ## # RPC-specific configuration for `list_engines` # @return [::Gapic::Config::Method] # attr_reader :list_engines ## # RPC-specific configuration for `pause_engine` # @return [::Gapic::Config::Method] # attr_reader :pause_engine ## # RPC-specific configuration for `resume_engine` # @return [::Gapic::Config::Method] # attr_reader :resume_engine ## # RPC-specific configuration for `tune_engine` # @return [::Gapic::Config::Method] # attr_reader :tune_engine # @private def initialize parent_rpcs = nil create_engine_config = parent_rpcs.create_engine if parent_rpcs.respond_to? :create_engine @create_engine = ::Gapic::Config::Method.new create_engine_config delete_engine_config = parent_rpcs.delete_engine if parent_rpcs.respond_to? :delete_engine @delete_engine = ::Gapic::Config::Method.new delete_engine_config update_engine_config = parent_rpcs.update_engine if parent_rpcs.respond_to? :update_engine @update_engine = ::Gapic::Config::Method.new update_engine_config get_engine_config = parent_rpcs.get_engine if parent_rpcs.respond_to? :get_engine @get_engine = ::Gapic::Config::Method.new get_engine_config list_engines_config = parent_rpcs.list_engines if parent_rpcs.respond_to? :list_engines @list_engines = ::Gapic::Config::Method.new list_engines_config pause_engine_config = parent_rpcs.pause_engine if parent_rpcs.respond_to? :pause_engine @pause_engine = ::Gapic::Config::Method.new pause_engine_config resume_engine_config = parent_rpcs.resume_engine if parent_rpcs.respond_to? :resume_engine @resume_engine = ::Gapic::Config::Method.new resume_engine_config tune_engine_config = parent_rpcs.tune_engine if parent_rpcs.respond_to? :tune_engine @tune_engine = ::Gapic::Config::Method.new tune_engine_config yield self if block_given? end end end end end end end end end