google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb

@@ -149,6 +149,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 = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Operations.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
+                end
+
                 @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::ServiceStub.new(
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
@@ -164,6 +171,13 @@ module Google
                 end
               end
 
+              ##
+              # Get the associated client for long-running operations.
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Operations]
+              #
+              attr_reader :operations_client
+
               ##
               # Get the associated client for mix-in of the Locations.
               #
@@ -199,8 +213,9 @@ module Google
               #     Required. The typeahead input used to fetch suggestions. Maximum length is
               #     128 characters.
               #   @param query_model [::String]
-              #     Selects data model of query suggestions for serving. Currently supported
-              #     values:
+              #     Specifies the autocomplete data model. This overrides any model specified
+              #     in the Configuration > Autocomplete section of the Cloud console. Currently
+              #     supported values:
               #
               #     * `document` - Using suggestions generated from user-imported documents.
               #     * `search-history` - Using suggestions generated from the past history of
@@ -214,8 +229,7 @@ module Google
               #     Default values:
               #
               #     * `document` is the default model for regular dataStores.
-              #     * `search-history` is the default model for
-              #     [IndustryVertical.SITE_SEARCH][] dataStores.
+              #     * `search-history` is the default model for site search dataStores.
               #   @param user_pseudo_id [::String]
               #     A unique identifier for tracking visitors. For example, this could be
               #     implemented with an HTTP cookie, which should be able to uniquely identify
@@ -294,6 +308,195 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Imports all
+              # {::Google::Cloud::DiscoveryEngine::V1::SuggestionDenyListEntry SuggestionDenyListEntry}
+              # for a DataStore.
+              #
+              # @overload import_suggestion_deny_list_entries(request, options = nil)
+              #   Pass arguments to `import_suggestion_deny_list_entries` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest, ::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_suggestion_deny_list_entries(inline_source: nil, gcs_source: nil, parent: nil)
+              #   Pass arguments to `import_suggestion_deny_list_entries` 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 inline_source [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest::InlineSource, ::Hash]
+              #     The Inline source for the input content for suggestion deny list entries.
+              #   @param gcs_source [::Google::Cloud::DiscoveryEngine::V1::GcsSource, ::Hash]
+              #     Cloud Storage location for the input content.
+              #
+              #     Only 1 file can be specified that contains all entries to import.
+              #     Supported values `gcs_source.schema` for autocomplete suggestion deny
+              #     list entry imports:
+              #
+              #     * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
+              #     per line.
+              #   @param parent [::String]
+              #     Required. The parent data store resource name for which to import denylist
+              #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/discovery_engine/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest.new
+              #
+              #   # Call the import_suggestion_deny_list_entries method.
+              #   result = client.import_suggestion_deny_list_entries 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_suggestion_deny_list_entries request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.import_suggestion_deny_list_entries.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.import_suggestion_deny_list_entries.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.import_suggestion_deny_list_entries.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @completion_service_stub.import_suggestion_deny_list_entries request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Permanently deletes all
+              # {::Google::Cloud::DiscoveryEngine::V1::SuggestionDenyListEntry SuggestionDenyListEntry}
+              # for a DataStore.
+              #
+              # @overload purge_suggestion_deny_list_entries(request, options = nil)
+              #   Pass arguments to `purge_suggestion_deny_list_entries` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest, ::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 purge_suggestion_deny_list_entries(parent: nil)
+              #   Pass arguments to `purge_suggestion_deny_list_entries` 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 data store resource name for which to import denylist
+              #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Gapic::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/discovery_engine/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest.new
+              #
+              #   # Call the purge_suggestion_deny_list_entries method.
+              #   result = client.purge_suggestion_deny_list_entries 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 purge_suggestion_deny_list_entries request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::PurgeSuggestionDenyListEntriesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.purge_suggestion_deny_list_entries.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.purge_suggestion_deny_list_entries.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.purge_suggestion_deny_list_entries.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @completion_service_stub.purge_suggestion_deny_list_entries request, options do |result, operation|
+                  result = ::Gapic::Operation.new result, @operations_client, options: options
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the CompletionService REST API.
               #
@@ -432,11 +635,25 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :complete_query
+                  ##
+                  # RPC-specific configuration for `import_suggestion_deny_list_entries`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :import_suggestion_deny_list_entries
+                  ##
+                  # RPC-specific configuration for `purge_suggestion_deny_list_entries`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :purge_suggestion_deny_list_entries
 
                   # @private
                   def initialize parent_rpcs = nil
                     complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
                     @complete_query = ::Gapic::Config::Method.new complete_query_config
+                    import_suggestion_deny_list_entries_config = parent_rpcs.import_suggestion_deny_list_entries if parent_rpcs.respond_to? :import_suggestion_deny_list_entries
+                    @import_suggestion_deny_list_entries = ::Gapic::Config::Method.new import_suggestion_deny_list_entries_config
+                    purge_suggestion_deny_list_entries_config = parent_rpcs.purge_suggestion_deny_list_entries if parent_rpcs.respond_to? :purge_suggestion_deny_list_entries
+                    @purge_suggestion_deny_list_entries = ::Gapic::Config::Method.new purge_suggestion_deny_list_entries_config
 
                     yield self if block_given?
                   end