google-cloud-retail-v2 0.4.0 → 0.5.1

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

@@ -90,8 +90,8 @@ module Google
             # [RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Contact Retail Support (retail-search-support@google.com) if you are
-            # interested in using Retail Search.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
             rpc :SetInventory, ::Google::Cloud::Retail::V2::SetInventoryRequest, ::Google::Longrunning::Operation
             # Incrementally adds place IDs to
             # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -106,8 +106,8 @@ module Google
             # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Contact Retail Support (retail-search-support@google.com) if you are
-            # interested in using Retail Search.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
             rpc :AddFulfillmentPlaces, ::Google::Cloud::Retail::V2::AddFulfillmentPlacesRequest, ::Google::Longrunning::Operation
             # Incrementally removes place IDs from a
             # [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids].
@@ -122,8 +122,8 @@ module Google
             # [ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Contact Retail Support (retail-search-support@google.com) if you are
-            # interested in using Retail Search.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
             rpc :RemoveFulfillmentPlaces, ::Google::Cloud::Retail::V2::RemoveFulfillmentPlacesRequest, ::Google::Longrunning::Operation
           end
 

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

@@ -30,8 +30,8 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Contact Retail Support (retail-search-support@google.com) if you are
-          # interested in using Retail Search.
+          # Please submit a form [here](https://cloud.google.com/contact) to contact
+          # cloud sales if you are interested in using Retail Search.
           #
           class Client
             include Paths
@@ -45,13 +45,12 @@ module Google
             # See {::Google::Cloud::Retail::V2::SearchService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all SearchService clients:
-            #
-            #     ::Google::Cloud::Retail::V2::SearchService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all SearchService clients
+            #   ::Google::Cloud::Retail::V2::SearchService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -69,9 +68,9 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.timeout = 60.0
+                default_config.timeout = 5.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -103,19 +102,15 @@ module Google
             ##
             # Create a new SearchService client object.
             #
-            # ## Examples
-            #
-            # To create a new SearchService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Retail::V2::SearchService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Retail::V2::SearchService::Client.new
             #
-            # To create a new SearchService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Retail::V2::SearchService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Retail::V2::SearchService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the SearchService client.
             # @yieldparam config [Client::Configuration]
@@ -135,10 +130,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -163,8 +157,8 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Contact Retail Support (retail-search-support@google.com) if you are
-            # interested in using Retail Search.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
             #
             # @overload search(request, options = nil)
             #   Pass arguments to `search` via a request object, either of type
@@ -236,8 +230,7 @@ module Google
             #   @param filter [::String]
             #     The filter syntax consists of an expression language for constructing a
             #     predicate from one or more fields of the products being filtered. Filter
-            #     expression is case-sensitive. See more details at this [user
-            #     guide](/retail/private/docs/filter-and-order#filter).
+            #     expression is case-sensitive.
             #
             #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
             #   @param canonical_filter [::String]
@@ -253,9 +246,7 @@ module Google
             #   @param order_by [::String]
             #     The order in which products are returned. Products can be ordered by
             #     a field in an {::Google::Cloud::Retail::V2::Product Product} object. Leave it
-            #     unset if ordered by relevance. OrderBy expression is case-sensitive. See
-            #     more details at this [user
-            #     guide](/retail/private/docs/filter-and-order#order).
+            #     unset if ordered by relevance. OrderBy expression is case-sensitive.
             #
             #     If this field is unrecognizable, an INVALID_ARGUMENT is returned.
             #   @param facet_specs [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>]
@@ -267,16 +258,13 @@ module Google
             #     The specification for dynamically generated facets. Notice that only
             #     textual facets can be dynamically generated.
             #
-            #     This feature requires additional allowlisting. Contact Retail Support
-            #     (retail-search-support@google.com) if you are interested in using dynamic
-            #     facet feature.
+            #     This feature requires additional allowlisting. Contact Retail Search
+            #     support team if you are interested in using dynamic facet feature.
             #   @param boost_spec [::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash]
-            #     Boost specification to boost certain products. See more details at this
-            #     [user guide](/retail/private/docs/boosting).
+            #     Boost specification to boost certain products.
             #   @param query_expansion_spec [::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash]
             #     The query expansion specification that specifies the conditions under which
-            #     query expansion will occur. See more details at this [user
-            #     guide](/retail/private/docs/result-size#query_expansion).
+            #     query expansion will occur.
             #   @param variant_rollup_keys [::Array<::String>]
             #     The keys to fetch and rollup the matching
             #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT variant}
@@ -287,10 +275,9 @@ module Google
             #     {::Google::Cloud::Retail::V2::Product Product}s attributes will lead to extra
             #     query latency. Maximum number of keys is 10.
             #
-            #     For
-            #     {::Google::Cloud::Retail::V2::Product#fulfillment_info Product.fulfillment_info},
-            #     a fulfillment type and a fulfillment ID must be provided in the format of
-            #     "fulfillmentType.filfillmentId". E.g., in "pickupInStore.store123",
+            #     For {::Google::Cloud::Retail::V2::FulfillmentInfo FulfillmentInfo}, a
+            #     fulfillment type and a fulfillment ID must be provided in the format of
+            #     "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123",
             #     "pickupInStore" is fulfillment type and "store123" is the store ID.
             #
             #     Supported keys are:
@@ -301,24 +288,42 @@ module Google
             #     * discount
             #     * attributes.key, where key is any key in the
             #       {::Google::Cloud::Retail::V2::Product#attributes Product.attributes} map.
-            #     * pickupInStore.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.PICKUP_IN_STORE][].
-            #     * shipToStore.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.SHIP_TO_STORE][].
-            #     * sameDayDelivery.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.SAME_DAY_DELIVERY][].
-            #     * nextDayDelivery.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.NEXT_DAY_DELIVERY][].
-            #     * customFulfillment1.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.CUSTOM_TYPE_1][].
-            #     * customFulfillment2.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.CUSTOM_TYPE_2][].
-            #     * customFulfillment3.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.CUSTOM_TYPE_3][].
-            #     * customFulfillment4.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.CUSTOM_TYPE_4][].
-            #     * customFulfillment5.id, where id is any [FulfillmentInfo.ids][] for type
-            #       [FulfillmentInfo.Type.CUSTOM_TYPE_5][].
+            #     * pickupInStore.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "pickup-in-store".
+            #     * shipToStore.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "ship-to-store".
+            #     * sameDayDelivery.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "same-day-delivery".
+            #     * nextDayDelivery.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "next-day-delivery".
+            #     * customFulfillment1.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "custom-type-1".
+            #     * customFulfillment2.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "custom-type-2".
+            #     * customFulfillment3.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "custom-type-3".
+            #     * customFulfillment4.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "custom-type-4".
+            #     * customFulfillment5.id, where id is any
+            #     {::Google::Cloud::Retail::V2::FulfillmentInfo#place_ids FulfillmentInfo.place_ids}
+            #     for {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type}
+            #       "custom-type-5".
             #
             #     If this field is set to an invalid value other than these, an
             #     INVALID_ARGUMENT error is returned.
@@ -370,7 +375,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.search.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.search.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @search_service_stub.call_rpc :search, request, options: options do |response, operation|
@@ -395,22 +402,21 @@ module Google
             # 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 search
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Retail::V2::SearchService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.search.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Retail::V2::SearchService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.search.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # search to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Retail::V2::SearchService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.search.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Retail::V2::SearchService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.search.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -34,8 +34,8 @@ module Google
         # Service for search.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Contact Retail Support (retail-search-support@google.com) if you are
-        # interested in using Retail Search.
+        # Please submit a form [here](https://cloud.google.com/contact) to contact
+        # cloud sales if you are interested in using Retail Search.
         #
         # To load this service and instantiate a client:
         #

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

@@ -66,6 +66,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec" do
       optional :condition, :enum, 1, "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition"
+      optional :pin_unexpanded_results, :bool, 2
     end
     add_enum "google.cloud.retail.v2.SearchRequest.QueryExpansionSpec.Condition" do
       value :CONDITION_UNSPECIFIED, 0
@@ -103,6 +104,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.retail.v2.SearchResponse.QueryExpansionInfo" do
       optional :expanded_query, :bool, 1
+      optional :pinned_result_count, :int64, 2
     end
   end
 end

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

@@ -27,8 +27,8 @@ module Google
           # Service for search.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Contact Retail Support (retail-search-support@google.com) if you are
-          # interested in using Retail Search.
+          # Please submit a form [here](https://cloud.google.com/contact) to contact
+          # cloud sales if you are interested in using Retail Search.
           class Service
 
             include GRPC::GenericService
@@ -40,8 +40,8 @@ module Google
             # Performs a search.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Contact Retail Support (retail-search-support@google.com) if you are
-            # interested in using Retail Search.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
             rpc :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
           end
 

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Retail::V2::UserEventService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all UserEventService clients:
-            #
-            #     ::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # 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]
@@ -65,9 +64,19 @@ module Google
                                 end
                 default_config = Client::Configuration.new parent_config
 
-                default_config.timeout = 60.0
+                default_config.timeout = 5.0
                 default_config.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                  initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.purge_user_events.timeout = 30.0
+                default_config.rpcs.purge_user_events.retry_policy = {
+                  initial_delay: 0.1, max_delay: 30.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
+                default_config.rpcs.import_user_events.timeout = 300.0
+                default_config.rpcs.import_user_events.retry_policy = {
+                  initial_delay: 0.1, max_delay: 300.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
                 default_config
@@ -99,19 +108,15 @@ module Google
             ##
             # Create a new UserEventService client object.
             #
-            # ## Examples
-            #
-            # To create a new UserEventService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new
+            #   # Create a client using 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
+            #   # Create a client using 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]
@@ -131,10 +136,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -225,7 +229,9 @@ module Google
               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,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :write_user_event, request, options: options do |response, operation|
@@ -308,7 +314,9 @@ module Google
               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,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :collect_user_event, request, options: options do |response, operation|
@@ -407,7 +415,9 @@ module Google
               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,
+
+              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|
@@ -485,7 +495,9 @@ module Google
               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,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :import_user_events, request, options: options do |response, operation|
@@ -564,7 +576,9 @@ module Google
               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,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @user_event_service_stub.call_rpc :rejoin_user_events, request, options: options do |response, operation|
@@ -589,22 +603,21 @@ module Google
             # 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
+            # @example
+            #
+            #   # 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
+            #
+            #   # 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.