google-cloud-retail-v2 0.4.1 → 0.6.0

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

@@ -169,7 +169,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.list_operations.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.list_operations.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -239,7 +241,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.get_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.get_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -309,7 +313,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.delete_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.delete_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -384,7 +390,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.cancel_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.cancel_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -456,7 +464,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.wait_operation.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.wait_operation.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +491,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 list_operations
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Longrunning::Operations::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Longrunning::Operations::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.list_operations.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # list_operations to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Longrunning::Operations::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Longrunning::Operations::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.list_operations.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.

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

@@ -1,8 +1,6 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/retail/v2/user_event_service.proto
 
-require 'google/protobuf'
-
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
@@ -11,6 +9,8 @@ require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/longrunning/operations_pb'
+require 'google/protobuf'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/user_event_service.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.WriteUserEventRequest" do

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

@@ -27,7 +27,7 @@ module Google
           # Service for ingesting end user actions on the customer website.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.4.1"
+        VERSION = "0.6.0"
       end
     end
   end

data/proto_docs/google/api/httpbody.rb

@@ -39,12 +39,15 @@ module Google
     #
     #       // The raw HTTP body is bound to this field.
     #       google.api.HttpBody http_body = 2;
+    #
     #     }
     #
     #     service ResourceService {
-    #       rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);
-    #       rpc UpdateResource(google.api.HttpBody) returns
-    #       (google.protobuf.Empty);
+    #       rpc GetResource(GetResourceRequest)
+    #         returns (google.api.HttpBody);
+    #       rpc UpdateResource(google.api.HttpBody)
+    #         returns (google.protobuf.Empty);
+    #
     #     }
     #
     # Example with streaming methods:
@@ -54,6 +57,7 @@ module Google
     #         returns (stream google.api.HttpBody);
     #       rpc UpdateCalendar(stream google.api.HttpBody)
     #         returns (stream google.api.HttpBody);
+    #
     #     }
     #
     # Use of this type only changes how the request and response bodies are

data/proto_docs/google/cloud/retail/v2/common.rb

@@ -80,7 +80,7 @@ module Google
         #     it is expected to have only 1 color. May consider using single "Mixed"
         #     instead of multiple values.
         #
-        #     A maximum of 5 colors are allowed. Each value must be a UTF-8 encoded
+        #     A maximum of 25 colors are allowed. Each value must be a UTF-8 encoded
         #     string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
@@ -174,8 +174,8 @@ module Google
         #     or the region IDs for
         #     {::Google::Cloud::Retail::V2::FulfillmentInfo#type FulfillmentInfo.type.same-day-delivery}.
         #
-        #     A maximum of 2000 values are allowed. Each value must be a string with a
-        #     length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as
+        #     A maximum of 3000 values are allowed. Each value must be a string with a
+        #     length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as
         #     "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.
         class FulfillmentInfo
           include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/retail/v2/completion_service.rb

@@ -80,13 +80,15 @@ module Google
         #     * user-data
         #
         #     * cloud-retail
-        #       This option is not automatically enabled. Before using cloud-retail,
-        #       contact retail-search-support@google.com first.
+        #       This option requires additional allowlisting. Before using cloud-retail,
+        #       contact Cloud Retail support team first.
         # @!attribute [rw] max_suggestions
         #   @return [::Integer]
-        #     Completion max suggestions.
+        #     Completion max suggestions. If left unset or set to 0, then will fallback
+        #     to the configured value [CompletionConfig.max_suggestions][].
         #
-        #     The maximum allowed max suggestions is 20. The default value is 20.
+        #     The maximum allowed max suggestions is 20. If it is set higher, it will be
+        #     capped by 20.
         class CompleteQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -105,9 +107,9 @@ module Google
         #     performance.
         # @!attribute [rw] recent_search_results
         #   @return [::Array<::Google::Cloud::Retail::V2::CompleteQueryResponse::RecentSearchResult>]
-        #     Matched recent searches of this user. This field is a restricted feature.
-        #     Contact Retail Support (retail-search-support@google.com) if you are
-        #     interested in enabling it.
+        #     Matched recent searches of this user. The maximum number of recent searches
+        #     is 10. This field is a restricted feature. Contact Retail Search support
+        #     team if you are interested in enabling it.
         #
         #     This feature is only available when
         #     {::Google::Cloud::Retail::V2::CompleteQueryRequest#visitor_id CompleteQueryRequest.visitor_id}

data/proto_docs/google/cloud/retail/v2/import_config.rb

@@ -201,13 +201,13 @@ module Google
             # Can only be while using
             # {::Google::Cloud::Retail::V2::BigQuerySource BigQuerySource}.
             #
-            # Add the IAM permission “BigQuery Data Viewer” for
+            # Add the IAM permission "BigQuery Data Viewer" for
             # cloud-retail-customer-data-access@system.gserviceaccount.com before
             # using this feature otherwise an error is thrown.
             #
             # 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.
             FULL = 2
           end
         end
@@ -284,7 +284,7 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::BigQuerySource]
         #     Required. BigQuery input source.
         #
-        #     Add the IAM permission “BigQuery Data Viewer” for
+        #     Add the IAM permission "BigQuery Data Viewer" for
         #     cloud-retail-customer-data-access@system.gserviceaccount.com before
         #     using this feature otherwise an error is thrown.
         class CompletionDataInputConfig

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -37,18 +37,23 @@ module Google
         #     and
         #     {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
         #
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} must be later
+        #     than {::Google::Cloud::Retail::V2::Product#available_time available_time} and
+        #     {::Google::Cloud::Retail::V2::Product#publish_time publish_time}, otherwise an
+        #     INVALID_ARGUMENT error is thrown.
+        #
         #     Google Merchant Center property
         #     [expiration_date](https://support.google.com/merchants/answer/6324499).
         # @!attribute [rw] ttl
         #   @return [::Google::Protobuf::Duration]
         #     Input only. The TTL (time to live) of the product.
         #
-        #     If it is set, {::Google::Cloud::Retail::V2::Product#expire_time expire_time}
-        #     is set as current timestamp plus
-        #     {::Google::Cloud::Retail::V2::Product#ttl ttl}. The derived
-        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is returned in
-        #     the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is left blank
-        #     when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
+        #     If it is set, it must be a non-negative value, and
+        #     {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is set as
+        #     current timestamp plus {::Google::Cloud::Retail::V2::Product#ttl ttl}. The
+        #     derived {::Google::Cloud::Retail::V2::Product#expire_time expire_time} is
+        #     returned in the output and {::Google::Cloud::Retail::V2::Product#ttl ttl} is
+        #     left blank when retrieving the {::Google::Cloud::Retail::V2::Product Product}.
         #
         #     If it is set, the product is not available for
         #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search} after
@@ -61,8 +66,6 @@ module Google
         #   @return [::String]
         #     Immutable. Full resource name of the product, such as
         #     `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`.
-        #
-        #     The branch ID must be "default_branch".
         # @!attribute [rw] id
         #   @return [::String]
         #     Immutable. {::Google::Cloud::Retail::V2::Product Product} identifier, which is
@@ -120,6 +123,9 @@ module Google
         #     This field must be a UTF-8 encoded string with a length limit of 128
         #     characters. Otherwise, an INVALID_ARGUMENT error is returned.
         #
+        #     This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is
+        #     returned.
+        #
         #     Google Merchant Center property
         #     [gtin](https://support.google.com/merchants/answer/6324461).
         #     Schema.org property
@@ -230,13 +236,9 @@ module Google
         #     This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
         #     error is returned:
         #
-        #     * Max entries count: 200 by default; 100 for
-        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
+        #     * Max entries count: 200.
         #     * The key must be a UTF-8 encoded string with a length limit of 128
         #       characters.
-        #     * Max indexable entries count: 200 by default; 40 for
-        #     {::Google::Cloud::Retail::V2::Product::Type::VARIANT Type.VARIANT}.
-        #     * Max searchable entries count: 30.
         #     * For indexable attribute, the key must match the pattern:
         #       [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS.
         # @!attribute [rw] tags
@@ -346,7 +348,7 @@ module Google
         #   @return [::Array<::String>]
         #     The material of the product. For example, "leather", "wooden".
         #
-        #     A maximum of 5 values are allowed. Each value must be a UTF-8 encoded
+        #     A maximum of 20 values are allowed. Each value must be a UTF-8 encoded
         #     string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.
         #
@@ -358,7 +360,7 @@ module Google
         #     The pattern or graphic print of the product. For example, "striped", "polka
         #     dot", "paisley".
         #
-        #     A maximum of 5 values are allowed per
+        #     A maximum of 20 values are allowed per
         #     {::Google::Cloud::Retail::V2::Product Product}. Each value must be a UTF-8
         #     encoded string with a length limit of 128 characters. Otherwise, an
         #     INVALID_ARGUMENT error is returned.
@@ -445,8 +447,12 @@ module Google
         #     * {::Google::Cloud::Retail::V2::Product#name name}
         #     * {::Google::Cloud::Retail::V2::Product#color_info color_info}
         #
-        #     Maximum number of paths is 20. Otherwise, an INVALID_ARGUMENT error is
+        #     Maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is
         #     returned.
+        #
+        #     Note: Returning more fields in
+        #     {::Google::Cloud::Retail::V2::SearchResponse SearchResponse} may increase
+        #     response payload size and serving latency.
         # @!attribute [r] variants
         #   @return [::Array<::Google::Cloud::Retail::V2::Product>]
         #     Output only. Product variants grouped together on primary product which

data/proto_docs/google/cloud/retail/v2/product_service.rb

@@ -290,7 +290,7 @@ module Google
         #     {::Google::Cloud::Retail::V2::Product#name Product.name} is not found, the
         #     inventory update will still be processed and retained for at most 1 day
         #     until the {::Google::Cloud::Retail::V2::Product Product} is created. If set to
-        #     false, an INVALID_ARGUMENT error is returned if the
+        #     false, a NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class SetInventoryRequest
           include ::Google::Protobuf::MessageExts
@@ -371,8 +371,8 @@ module Google
         #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
         #     found, the fulfillment information will still be processed and retained for
         #     at most 1 day and processed once the
-        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+        #     NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class AddFulfillmentPlacesRequest
           include ::Google::Protobuf::MessageExts
@@ -387,7 +387,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # Response of the RemoveFulfillmentPlacesRequest.  Currently empty because
+        # Response of the AddFulfillmentPlacesRequest.  Currently empty because
         # there is no meaningful response populated from the [AddFulfillmentPlaces][]
         # method.
         class AddFulfillmentPlacesResponse
@@ -448,8 +448,8 @@ module Google
         #     If set to true, and the {::Google::Cloud::Retail::V2::Product Product} is not
         #     found, the fulfillment information will still be processed and retained for
         #     at most 1 day and processed once the
-        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, an
-        #     INVALID_ARGUMENT error is returned if the
+        #     {::Google::Cloud::Retail::V2::Product Product} is created. If set to false, a
+        #     NOT_FOUND error is returned if the
         #     {::Google::Cloud::Retail::V2::Product Product} is not found.
         class RemoveFulfillmentPlacesRequest
           include ::Google::Protobuf::MessageExts