google-cloud-retail-v2 0.1.0

data/lib/google/cloud/retail/v2/product_service/paths.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module ProductService
+          # Path helper methods for the ProductService API.
+          module Paths
+            ##
+            # Create a fully-qualified Branch resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            # @param branch [String]
+            #
+            # @return [::String]
+            def branch_path project:, location:, catalog:, branch:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "catalog cannot contain /" if catalog.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}/branches/#{branch}"
+            end
+
+            ##
+            # Create a fully-qualified Product resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/branches/{branch}/products/{product}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            # @param branch [String]
+            # @param product [String]
+            #
+            # @return [::String]
+            def product_path project:, location:, catalog:, branch:, product:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+              raise ::ArgumentError, "catalog cannot contain /" if catalog.to_s.include? "/"
+              raise ::ArgumentError, "branch cannot contain /" if branch.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}/branches/#{branch}/products/#{product}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/product_service_pb.rb

@@ -0,0 +1,47 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/product_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/import_config_pb'
+require 'google/cloud/retail/v2/product_pb'
+require 'google/cloud/retail/v2/purge_config_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/product_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.CreateProductRequest" do
+      optional :parent, :string, 1
+      optional :product, :message, 2, "google.cloud.retail.v2.Product"
+      optional :product_id, :string, 3
+    end
+    add_message "google.cloud.retail.v2.GetProductRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.UpdateProductRequest" do
+      optional :product, :message, 1, "google.cloud.retail.v2.Product"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.retail.v2.DeleteProductRequest" do
+      optional :name, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        CreateProductRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CreateProductRequest").msgclass
+        GetProductRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetProductRequest").msgclass
+        UpdateProductRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateProductRequest").msgclass
+        DeleteProductRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.DeleteProductRequest").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/product_service_services_pb.rb

@@ -0,0 +1,60 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/product_service.proto for package 'Google.Cloud.Retail.V2'
+# Original file comments:
+# Copyright 2020 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/cloud/retail/v2/product_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module ProductService
+          # Service for ingesting [Product][google.cloud.retail.v2.Product] information
+          # of the customer's website.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.ProductService'
+
+            # Creates a [Product][google.cloud.retail.v2.Product].
+            rpc :CreateProduct, ::Google::Cloud::Retail::V2::CreateProductRequest, ::Google::Cloud::Retail::V2::Product
+            # Gets a [Product][google.cloud.retail.v2.Product].
+            rpc :GetProduct, ::Google::Cloud::Retail::V2::GetProductRequest, ::Google::Cloud::Retail::V2::Product
+            # Updates a [Product][google.cloud.retail.v2.Product].
+            rpc :UpdateProduct, ::Google::Cloud::Retail::V2::UpdateProductRequest, ::Google::Cloud::Retail::V2::Product
+            # Deletes a [Product][google.cloud.retail.v2.Product].
+            rpc :DeleteProduct, ::Google::Cloud::Retail::V2::DeleteProductRequest, ::Google::Protobuf::Empty
+            # Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.
+            #
+            # Request processing may be synchronous. No partial updating is supported.
+            # Non-existing items are created.
+            #
+            # Note that it is possible for a subset of the
+            # [Product][google.cloud.retail.v2.Product]s to be successfully updated.
+            rpc :ImportProducts, ::Google::Cloud::Retail::V2::ImportProductsRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/purge_config_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/purge_config.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/purge_config.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.PurgeMetadata" do
+    end
+    add_message "google.cloud.retail.v2.PurgeUserEventsRequest" do
+      optional :parent, :string, 1
+      optional :filter, :string, 2
+      optional :force, :bool, 3
+    end
+    add_message "google.cloud.retail.v2.PurgeUserEventsResponse" do
+      optional :purged_events_count, :int64, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        PurgeMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PurgeMetadata").msgclass
+        PurgeUserEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PurgeUserEventsRequest").msgclass
+        PurgeUserEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PurgeUserEventsResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/user_event_pb.rb

@@ -0,0 +1,55 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/user_event.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+require 'google/cloud/retail/v2/common_pb'
+require 'google/cloud/retail/v2/product_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/user_event.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.UserEvent" do
+      optional :event_type, :string, 1
+      optional :visitor_id, :string, 2
+      optional :event_time, :message, 3, "google.protobuf.Timestamp"
+      repeated :experiment_ids, :string, 4
+      optional :attribution_token, :string, 5
+      repeated :product_details, :message, 6, "google.cloud.retail.v2.ProductDetail"
+      map :attributes, :string, :message, 7, "google.cloud.retail.v2.CustomAttribute"
+      optional :cart_id, :string, 8
+      optional :purchase_transaction, :message, 9, "google.cloud.retail.v2.PurchaseTransaction"
+      optional :search_query, :string, 10
+      repeated :page_categories, :string, 11
+      optional :user_info, :message, 12, "google.cloud.retail.v2.UserInfo"
+      optional :uri, :string, 13
+      optional :referrer_uri, :string, 14
+      optional :page_view_id, :string, 15
+    end
+    add_message "google.cloud.retail.v2.ProductDetail" do
+      optional :product, :message, 1, "google.cloud.retail.v2.Product"
+      optional :quantity, :message, 2, "google.protobuf.Int32Value"
+    end
+    add_message "google.cloud.retail.v2.PurchaseTransaction" do
+      optional :id, :string, 1
+      optional :revenue, :float, 2
+      optional :tax, :float, 3
+      optional :cost, :float, 4
+      optional :currency_code, :string, 5
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        UserEvent = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserEvent").msgclass
+        ProductDetail = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ProductDetail").msgclass
+        PurchaseTransaction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PurchaseTransaction").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/user_event_service.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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/retail/v2/version"
+
+require "google/cloud/retail/v2/user_event_service/credentials"
+require "google/cloud/retail/v2/user_event_service/paths"
+require "google/cloud/retail/v2/user_event_service/operations"
+require "google/cloud/retail/v2/user_event_service/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Service for ingesting end user actions on the customer website.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/retail/v2/user_event_service"
+        #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
+        #
+        module UserEventService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "user_event_service", "helpers.rb"
+require "google/cloud/retail/v2/user_event_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/retail/v2/user_event_service/client.rb

@@ -0,0 +1,760 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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/retail/v2/user_event_service_pb"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module UserEventService
+          ##
+          # Client for the UserEventService service.
+          #
+          # Service for ingesting end user actions on the customer website.
+          #
+          class Client
+            include Paths
+
+            # @private
+            attr_reader :user_event_service_stub
+
+            ##
+            # Configure the UserEventService Client class.
+            #
+            # See {::Google::Cloud::Retail::V2::UserEventService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # ## Example
+            #
+            # To modify the configuration for all UserEventService clients:
+            #
+            #     ::Google::Cloud::Retail::V2::UserEventService::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", "Retail", "V2"]
+                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.timeout = 60.0
+                default_config.retry_policy = {
+                  initial_delay: 0.1,
+                  max_delay:     60.0,
+                  multiplier:    1.3,
+                  retry_codes:   [14, 4]
+                }
+
+                default_config
+              end
+              yield @configure if block_given?
+              @configure
+            end
+
+            ##
+            # Configure the UserEventService 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::Retail::V2::UserEventService::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
+
+            ##
+            # Create a new UserEventService client object.
+            #
+            # ## Examples
+            #
+            # To create a new UserEventService client with the default
+            # configuration:
+            #
+            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
+            #
+            # To create a new UserEventService client with a custom
+            # configuration:
+            #
+            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
+            #       config.timeout = 10.0
+            #     end
+            #
+            # @yield [config] Configure the UserEventService 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/retail/v2/user_event_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
+              credentials ||= Credentials.default scope: @config.scope
+              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.endpoint = @config.endpoint
+              end
+
+              @user_event_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::Retail::V2::UserEventService::Stub,
+                credentials:  credentials,
+                endpoint:     @config.endpoint,
+                channel_args: @config.channel_args,
+                interceptors: @config.interceptors
+              )
+            end
+
+            ##
+            # Get the associated client for long-running operations.
+            #
+            # @return [::Google::Cloud::Retail::V2::UserEventService::Operations]
+            #
+            attr_reader :operations_client
+
+            # Service calls
+
+            ##
+            # Writes a single user event.
+            #
+            # @overload write_user_event(request, options = nil)
+            #   Pass arguments to `write_user_event` via a request object, either of type
+            #   {::Google::Cloud::Retail::V2::WriteUserEventRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::WriteUserEventRequest, ::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 write_user_event(parent: nil, user_event: nil)
+            #   Pass arguments to `write_user_event` 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 catalog resource name, such as
+            #     "projects/1234/locations/global/catalogs/default_catalog".
+            #   @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
+            #     Required. User event to write.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Retail::V2::UserEvent]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Retail::V2::UserEvent]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def write_user_event request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::WriteUserEventRequest
+
+              # 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.write_user_event.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "parent" => request.parent
+              }
+              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.write_user_event.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.write_user_event.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_event_service_stub.call_rpc :write_user_event, 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
+
+            ##
+            # Writes a single user event from the browser. This uses a GET request to
+            # due to browser restriction of POST-ing to a 3rd party domain.
+            #
+            # This method is used only by the Retail API JavaScript pixel and Google Tag
+            # Manager. Users should not call this method directly.
+            #
+            # @overload collect_user_event(request, options = nil)
+            #   Pass arguments to `collect_user_event` via a request object, either of type
+            #   {::Google::Cloud::Retail::V2::CollectUserEventRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::CollectUserEventRequest, ::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 collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil)
+            #   Pass arguments to `collect_user_event` 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 catalog name, such as
+            #     "projects/1234/locations/global/catalogs/default_catalog".
+            #   @param user_event [::String]
+            #     Required. URL encoded UserEvent proto with a length limit of 2,000,000
+            #     characters.
+            #   @param uri [::String]
+            #     The URL including cgi-parameters but excluding the hash fragment with a
+            #     length limit of 5,000 characters. This is often more useful than the
+            #     referer URL, because many browsers only send the domain for 3rd party
+            #     requests.
+            #   @param ets [::Integer]
+            #     The event timestamp in milliseconds. This prevents browser caching of
+            #     otherwise identical get requests. The name is abbreviated to reduce the
+            #     payload bytes.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Api::HttpBody]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Api::HttpBody]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def collect_user_event request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::CollectUserEventRequest
+
+              # 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.collect_user_event.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "parent" => request.parent
+              }
+              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.collect_user_event.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.collect_user_event.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_event_service_stub.call_rpc :collect_user_event, 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
+
+            ##
+            # 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::Retail::V2::PurgeUserEventsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::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/$\\{projectId}/locations/global/catalogs/$\\{catalogId}"
+            #   @param filter [::String]
+            #     Required. The filter string to specify the events to be deleted with a
+            #     length limit of 5,000 characters. Empty string filter is not allowed. The
+            #     eligible fields for filtering are:
+            #
+            #     * `eventType`: Double quoted
+            #     {::Google::Cloud::Retail::V2::UserEvent#event_type UserEvent.event_type} string.
+            #     * `eventTime`: in ISO 8601 "zulu" format.
+            #     * `visitorId`: 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 in time range:
+            #       `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
+            #     * Deleting all events for a specific visitor:
+            #       `visitorId = "visitor1024"`
+            #
+            #     The filtering fields are assumed to have an implicit AND.
+            #   @param force [::Boolean]
+            #     Actually perform the purge.
+            #     If `force` is set to false, the method will return the expected purge count
+            #     without deleting any user events.
+            #
+            # @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.
+            #
+            def purge_user_events request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::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 and x-goog-user-project 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::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "parent" => request.parent
+              }
+              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 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.
+            # Use this method for backfilling historical user events.
+            #
+            # Operation.response is of type ImportResponse. Note that it is
+            # possible for a subset of the items to be successfully inserted.
+            # Operation.metadata is of type ImportMetadata.
+            #
+            # @overload import_user_events(request, options = nil)
+            #   Pass arguments to `import_user_events` via a request object, either of type
+            #   {::Google::Cloud::Retail::V2::ImportUserEventsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::ImportUserEventsRequest, ::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_user_events(parent: nil, input_config: nil, errors_config: nil)
+            #   Pass arguments to `import_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. "projects/1234/locations/global/catalogs/default_catalog"
+            #   @param input_config [::Google::Cloud::Retail::V2::UserEventInputConfig, ::Hash]
+            #     Required. The desired input location of the data.
+            #   @param errors_config [::Google::Cloud::Retail::V2::ImportErrorsConfig, ::Hash]
+            #     The desired location of errors incurred during the Import. Cannot be set
+            #     for inline user event imports.
+            #
+            # @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.
+            #
+            def import_user_events request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::ImportUserEventsRequest
+
+              # 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.import_user_events.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "parent" => request.parent
+              }
+              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.import_user_events.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.import_user_events.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_event_service_stub.call_rpc :import_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
+
+            ##
+            # Triggers a user event rejoin operation with latest product catalog. Events
+            # will not be annotated with detailed product information if product is
+            # missing from the catalog at the time the user event is ingested, and these
+            # events are stored as unjoined events with a limited usage on training and
+            # serving. This API can be used to trigger a 'join' operation on specified
+            # events with latest version of product catalog. It can also be used to
+            # correct events joined with wrong product catalog.
+            #
+            # @overload rejoin_user_events(request, options = nil)
+            #   Pass arguments to `rejoin_user_events` via a request object, either of type
+            #   {::Google::Cloud::Retail::V2::RejoinUserEventsRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::RejoinUserEventsRequest, ::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 rejoin_user_events(parent: nil, user_event_rejoin_scope: nil)
+            #   Pass arguments to `rejoin_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 parent catalog resource name, such as
+            #     "projects/1234/locations/global/catalogs/default_catalog".
+            #   @param user_event_rejoin_scope [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
+            #     The type of the user event rejoin to define the scope and range of the user
+            #     events to be rejoined with the latest product catalog. Defaults to
+            #     USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
+            #     invalid integer value.
+            #
+            # @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.
+            #
+            def rejoin_user_events request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::RejoinUserEventsRequest
+
+              # 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.rejoin_user_events.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project 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::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "parent" => request.parent
+              }
+              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.rejoin_user_events.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.rejoin_user_events.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @user_event_service_stub.call_rpc :rejoin_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
+
+            ##
+            # Configuration class for the UserEventService API.
+            #
+            # This class represents the configuration for UserEventService,
+            # 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::Retail::V2::UserEventService::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.
+            #
+            # # Examples
+            #
+            # To modify the global config, setting the timeout for write_user_event
+            # to 20 seconds, and all remaining timeouts to 10 seconds:
+            #
+            #     ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.write_user_event.timeout = 20.0
+            #     end
+            #
+            # To apply the above configuration only to a new client:
+            #
+            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
+            #       config.timeout = 10.0
+            #       config.rpcs.write_user_event.timeout = 20.0
+            #     end
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"retail.googleapis.com"`.
+            #   @return [::String]
+            # @!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://googleapis.dev/ruby/googleauth/latest/index.html))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #    *  (`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<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
+            #
+            class Configuration
+              extend ::Gapic::Config
+
+              config_attr :endpoint,      "retail.googleapis.com", ::String
+              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
+
+              # @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 RPC class for the UserEventService 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 milliseconds
+              #  *  `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<String>`) - The error codes that should
+              #         trigger a retry.
+              #
+              class Rpcs
+                ##
+                # RPC-specific configuration for `write_user_event`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :write_user_event
+                ##
+                # RPC-specific configuration for `collect_user_event`
+                # @return [::Gapic::Config::Method]
+                #
+                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]
+                #
+                attr_reader :import_user_events
+                ##
+                # RPC-specific configuration for `rejoin_user_events`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :rejoin_user_events
+
+                # @private
+                def initialize parent_rpcs = nil
+                  write_user_event_config = parent_rpcs&.write_user_event if parent_rpcs&.respond_to? :write_user_event
+                  @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
+                  rejoin_user_events_config = parent_rpcs&.rejoin_user_events if parent_rpcs&.respond_to? :rejoin_user_events
+                  @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config
+
+                  yield self if block_given?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end