google-cloud-discovery_engine-v1 1.0.2 → 1.2.0

data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/service_stub.rb

@@ -0,0 +1,188 @@
+# 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/discoveryengine/v1/search_tuning_service_pb"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        module SearchTuningService
+          module Rest
+            ##
+            # REST service stub for the SearchTuningService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @client_stub.universe_domain
+              end
+
+              ##
+              # The effective endpoint
+              #
+              # @return [String]
+              #
+              def endpoint
+                @client_stub.endpoint
+              end
+
+              ##
+              # Baseline implementation for the train_custom_model REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::TrainCustomModelRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Longrunning::Operation]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Longrunning::Operation]
+              #   A result object deserialized from the server's reply
+              def train_custom_model request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_train_custom_model_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # Baseline implementation for the list_custom_models REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListCustomModelsRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ListCustomModelsResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::ListCustomModelsResponse]
+              #   A result object deserialized from the server's reply
+              def list_custom_models request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_list_custom_models_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::DiscoveryEngine::V1::ListCustomModelsResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the train_custom_model REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::TrainCustomModelRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_train_custom_model_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{data_store}:trainCustomModel",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["data_store", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the list_custom_models REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::ListCustomModelsRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_list_custom_models_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{data_store}/customModels",
+                                                          matches: [
+                                                            ["data_store", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest.rb

@@ -0,0 +1,53 @@
+# 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 "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/search_tuning_service/credentials"
+require "google/cloud/discovery_engine/v1/search_tuning_service/paths"
+require "google/cloud/discovery_engine/v1/search_tuning_service/rest/operations"
+require "google/cloud/discovery_engine/v1/search_tuning_service/rest/client"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for search tuning.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Rest::Client.new
+        #
+        module SearchTuningService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/discovery_engine/v1/search_tuning_service/rest/helpers" if ::File.file? helper_path

data/lib/google/cloud/discovery_engine/v1/search_tuning_service.rb

@@ -0,0 +1,56 @@
+# 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 "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/search_tuning_service/credentials"
+require "google/cloud/discovery_engine/v1/search_tuning_service/paths"
+require "google/cloud/discovery_engine/v1/search_tuning_service/operations"
+require "google/cloud/discovery_engine/v1/search_tuning_service/client"
+require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for search tuning.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/discovery_engine/v1/search_tuning_service"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client.new
+        #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Rest::Client.new
+        #
+        module SearchTuningService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "search_tuning_service", "helpers.rb"
+require "google/cloud/discovery_engine/v1/search_tuning_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb

@@ -1100,7 +1100,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload recrawl_uris(site_search_engine: nil, uris: nil)
+            # @overload recrawl_uris(site_search_engine: nil, uris: nil, site_credential: nil)
             #   Pass arguments to `recrawl_uris` 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).
@@ -1114,6 +1114,10 @@ module Google
             #     an INVALID_ARGUMENT error is thrown. Each URI should match at least one
             #     {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} in
             #     `site_search_engine`.
+            #   @param site_credential [::String]
+            #     Optional. Full resource name of the [SiteCredential][], such as
+            #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
+            #     Only set to crawl private URIs.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]

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

@@ -1030,7 +1030,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload recrawl_uris(site_search_engine: nil, uris: nil)
+              # @overload recrawl_uris(site_search_engine: nil, uris: nil, site_credential: nil)
               #   Pass arguments to `recrawl_uris` 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).
@@ -1044,6 +1044,10 @@ module Google
               #     an INVALID_ARGUMENT error is thrown. Each URI should match at least one
               #     {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite} in
               #     `site_search_engine`.
+              #   @param site_credential [::String]
+              #     Optional. Full resource name of the [SiteCredential][], such as
+              #     `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`.
+              #     Only set to crawl private URIs.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]

data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb

@@ -911,6 +911,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}/operations",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}/operations",
@@ -1030,6 +1037,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}",

data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb

@@ -405,6 +405,138 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Deletes permanently all user events specified by the filter provided.
+            # Depending on the number of events specified by the filter, this operation
+            # could take hours or days to complete. To test a filter, use the list
+            # command first.
+            #
+            # @overload purge_user_events(request, options = nil)
+            #   Pass arguments to `purge_user_events` via a request object, either of type
+            #   {::Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest, ::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_user_events(parent: nil, filter: nil, force: nil)
+            #   Pass arguments to `purge_user_events` 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 resource name of the catalog under which the events are
+            #     created. The format is
+            #     `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.
+            #   @param filter [::String]
+            #     Required. The filter string to specify the events to be deleted with a
+            #     length limit of 5,000 characters. The eligible fields for filtering are:
+            #
+            #     * `eventType`: Double quoted
+            #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#event_type UserEvent.event_type}
+            #     string.
+            #     * `eventTime`: in ISO 8601 "zulu" format.
+            #     * `userPseudoId`: Double quoted string. Specifying this will delete all
+            #       events associated with a visitor.
+            #     * `userId`: Double quoted string. Specifying this will delete all events
+            #       associated with a user.
+            #
+            #     Examples:
+            #
+            #     * Deleting all events in a time range:
+            #       `eventTime > "2012-04-23T18:25:43.511Z"
+            #       eventTime < "2012-04-23T18:30:43.511Z"`
+            #     * Deleting specific eventType:
+            #       `eventType = "search"`
+            #     * Deleting all events for a specific visitor:
+            #       `userPseudoId = "visitor1024"`
+            #     * Deleting all events inside a DataStore:
+            #       `*`
+            #
+            #     The filtering fields are assumed to have an implicit AND.
+            #   @param force [::Boolean]
+            #     The `force` field is currently not supported. Purge user event requests
+            #     will permanently delete all purgeable events. Once the development is
+            #     complete:
+            #     If `force` is set to false, the method will return the expected
+            #     purge count without deleting any user events. This field will default to
+            #     false if not included in the request.
+            #
+            # @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/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DiscoveryEngine::V1::UserEventService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest.new
+            #
+            #   # Call the purge_user_events method.
+            #   result = client.purge_user_events 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_user_events request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::PurgeUserEventsRequest
+
+              # 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.purge_user_events.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::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.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.purge_user_events.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.purge_user_events.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_event_service_stub.call_rpc :purge_user_events, 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
+
             ##
             # Bulk import of user events. Request processing might be
             # synchronous. Events that already exist are skipped.
@@ -679,6 +811,11 @@ module Google
                 #
                 attr_reader :collect_user_event
                 ##
+                # RPC-specific configuration for `purge_user_events`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :purge_user_events
+                ##
                 # RPC-specific configuration for `import_user_events`
                 # @return [::Gapic::Config::Method]
                 #
@@ -690,6 +827,8 @@ module Google
                   @write_user_event = ::Gapic::Config::Method.new write_user_event_config
                   collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
                   @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
+                  purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
+                  @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
                   import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
                   @import_user_events = ::Gapic::Config::Method.new import_user_events_config