google-cloud-retail-v2 0.10.0 → 0.12.0

data/lib/google/cloud/retail/v2/serving_config_service/credentials.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 "googleauth"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module ServingConfigService
+          # Credentials for the ServingConfigService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "RETAIL_CREDENTIALS",
+              "RETAIL_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "RETAIL_CREDENTIALS_JSON",
+              "RETAIL_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 ServingConfigService
+          # Path helper methods for the ServingConfigService API.
+          module Paths
+            ##
+            # Create a fully-qualified Catalog resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            #
+            # @return [::String]
+            def catalog_path project:, location:, catalog:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}"
+            end
+
+            ##
+            # Create a fully-qualified ServingConfig resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            # @param serving_config [String]
+            #
+            # @return [::String]
+            def serving_config_path project:, location:, catalog:, serving_config:
+              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}/servingConfigs/#{serving_config}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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/serving_config_service/credentials"
+require "google/cloud/retail/v2/serving_config_service/paths"
+require "google/cloud/retail/v2/serving_config_service/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Service for modifying ServingConfig.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/retail/v2/serving_config_service"
+        #     client = ::Google::Cloud::Retail::V2::ServingConfigService::Client.new
+        #
+        module ServingConfigService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "serving_config_service", "helpers.rb"
+require "google/cloud/retail/v2/serving_config_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,66 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/serving_config_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/serving_config_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/serving_config_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.CreateServingConfigRequest" do
+      optional :parent, :string, 1
+      optional :serving_config, :message, 2, "google.cloud.retail.v2.ServingConfig"
+      optional :serving_config_id, :string, 3
+    end
+    add_message "google.cloud.retail.v2.UpdateServingConfigRequest" do
+      optional :serving_config, :message, 1, "google.cloud.retail.v2.ServingConfig"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.retail.v2.DeleteServingConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.GetServingConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.ListServingConfigsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.retail.v2.ListServingConfigsResponse" do
+      repeated :serving_configs, :message, 1, "google.cloud.retail.v2.ServingConfig"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.retail.v2.AddControlRequest" do
+      optional :serving_config, :string, 1
+      optional :control_id, :string, 2
+    end
+    add_message "google.cloud.retail.v2.RemoveControlRequest" do
+      optional :serving_config, :string, 1
+      optional :control_id, :string, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        CreateServingConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CreateServingConfigRequest").msgclass
+        UpdateServingConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateServingConfigRequest").msgclass
+        DeleteServingConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.DeleteServingConfigRequest").msgclass
+        GetServingConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetServingConfigRequest").msgclass
+        ListServingConfigsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListServingConfigsRequest").msgclass
+        ListServingConfigsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListServingConfigsResponse").msgclass
+        AddControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AddControlRequest").msgclass
+        RemoveControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.RemoveControlRequest").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/serving_config_service.proto for package 'Google.Cloud.Retail.V2'
+# Original file comments:
+# 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
+#
+#     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/serving_config_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module ServingConfigService
+          # Service for modifying ServingConfig.
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.ServingConfigService'
+
+            # Creates a ServingConfig.
+            #
+            # A maximum of 100 [ServingConfig][google.cloud.retail.v2.ServingConfig]s are
+            # allowed in a [Catalog][google.cloud.retail.v2.Catalog], otherwise a
+            # FAILED_PRECONDITION error is returned.
+            rpc :CreateServingConfig, ::Google::Cloud::Retail::V2::CreateServingConfigRequest, ::Google::Cloud::Retail::V2::ServingConfig
+            # Deletes a ServingConfig.
+            #
+            # Returns a NotFound error if the ServingConfig does not exist.
+            rpc :DeleteServingConfig, ::Google::Cloud::Retail::V2::DeleteServingConfigRequest, ::Google::Protobuf::Empty
+            # Updates a ServingConfig.
+            rpc :UpdateServingConfig, ::Google::Cloud::Retail::V2::UpdateServingConfigRequest, ::Google::Cloud::Retail::V2::ServingConfig
+            # Gets a ServingConfig.
+            #
+            # Returns a NotFound error if the ServingConfig does not exist.
+            rpc :GetServingConfig, ::Google::Cloud::Retail::V2::GetServingConfigRequest, ::Google::Cloud::Retail::V2::ServingConfig
+            # Lists all ServingConfigs linked to this catalog.
+            rpc :ListServingConfigs, ::Google::Cloud::Retail::V2::ListServingConfigsRequest, ::Google::Cloud::Retail::V2::ListServingConfigsResponse
+            # Enables a Control on the specified ServingConfig.
+            # The control is added in the last position of the list of controls
+            # it belongs to (e.g. if it's a facet spec control it will be applied
+            # in the last position of servingConfig.facetSpecIds)
+            # Returns a ALREADY_EXISTS error if the control has already been applied.
+            # Returns a FAILED_PRECONDITION error if the addition could exceed maximum
+            # number of control allowed for that type of control.
+            rpc :AddControl, ::Google::Cloud::Retail::V2::AddControlRequest, ::Google::Cloud::Retail::V2::ServingConfig
+            # Disables a Control on the specified ServingConfig.
+            # The control is removed from the ServingConfig.
+            # Returns a NOT_FOUND error if the Control is not enabled for the
+            # ServingConfig.
+            rpc :RemoveControl, ::Google::Cloud::Retail::V2::RemoveControlRequest, ::Google::Cloud::Retail::V2::ServingConfig
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -185,7 +185,7 @@ module Google
             #   @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)
+            # @overload write_user_event(parent: nil, user_event: nil, write_async: 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).
@@ -195,6 +195,11 @@ module Google
             #     `projects/1234/locations/global/catalogs/default_catalog`.
             #   @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
             #     Required. User event to write.
+            #   @param write_async [::Boolean]
+            #     If set to true, the user event will be written asynchronously after
+            #     validation, and the API will respond without waiting for the write.
+            #     Therefore, silent failures can occur even if the API returns success. In
+            #     case of silent failures, error messages can be found in Stackdriver logs.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::UserEvent]
@@ -277,11 +282,14 @@ module Google
             #   @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)
+            # @overload collect_user_event(prebuilt_rule: nil, parent: nil, user_event: nil, uri: nil, ets: nil, raw_json: 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 prebuilt_rule [::String]
+            #     The prebuilt rule name that can convert a specific type of raw_json.
+            #     For example: "default_schema/v1.0"
             #   @param parent [::String]
             #     Required. The parent catalog name, such as
             #     `projects/1234/locations/global/catalogs/default_catalog`.
@@ -297,6 +305,11 @@ module Google
             #     The event timestamp in milliseconds. This prevents browser caching of
             #     otherwise identical get requests. The name is abbreviated to reduce the
             #     payload bytes.
+            #   @param raw_json [::String]
+            #     An arbitrary serialized JSON string that contains necessary information
+            #     that can comprise a user event. When this field is specified, the
+            #     user_event field will be ignored. Note: line-delimited JSON is not
+            #     supported, a single JSON only.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Api::HttpBody]
@@ -493,9 +506,9 @@ module Google
             # 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
+            # `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.
+            # `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
@@ -593,14 +606,14 @@ module Google
             end
 
             ##
-            # Starts 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 method can be used to start a join operation on specified
-            # events with latest version of product catalog. It can also be used to
-            # correct events joined with the wrong product catalog. A rejoin operation
-            # can take hours or days to complete.
+            # Starts a user-event rejoin operation with latest product catalog. Events
+            # are not annotated with detailed product information for products that are
+            # missing from the catalog when the user event is ingested. These
+            # events are stored as unjoined events with limited usage on training and
+            # serving. You can use this method to start a join operation on specified
+            # events with the latest version of product catalog. You can also use this
+            # method to correct events joined with the wrong product catalog. A rejoin
+            # operation can take hours or days to complete.
             #
             # @overload rejoin_user_events(request, options = nil)
             #   Pass arguments to `rejoin_user_events` via a request object, either of type
@@ -623,8 +636,8 @@ module Google
             #   @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.
+            #     `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]

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

@@ -34,7 +34,7 @@ module Google
         ##
         # Service for ingesting end user actions on the customer website.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/user_event_service"
         #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new

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

@@ -18,12 +18,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.retail.v2.WriteUserEventRequest" do
       optional :parent, :string, 1
       optional :user_event, :message, 2, "google.cloud.retail.v2.UserEvent"
+      optional :write_async, :bool, 3
     end
     add_message "google.cloud.retail.v2.CollectUserEventRequest" do
       optional :parent, :string, 1
       optional :user_event, :string, 2
       optional :uri, :string, 3
       optional :ets, :int64, 4
+      optional :raw_json, :string, 5
+      oneof :conversion_rule do
+        optional :prebuilt_rule, :string, 6
+      end
     end
     add_message "google.cloud.retail.v2.RejoinUserEventsRequest" do
       optional :parent, :string, 1

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

@@ -50,18 +50,18 @@ module Google
             # 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
+            # `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.
+            # `Operation.metadata` is of type `ImportMetadata`.
             rpc :ImportUserEvents, ::Google::Cloud::Retail::V2::ImportUserEventsRequest, ::Google::Longrunning::Operation
-            # Starts 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 method can be used to start a join operation on specified
-            # events with latest version of product catalog. It can also be used to
-            # correct events joined with the wrong product catalog. A rejoin operation
-            # can take hours or days to complete.
+            # Starts a user-event rejoin operation with latest product catalog. Events
+            # are not annotated with detailed product information for products that are
+            # missing from the catalog when the user event is ingested. These
+            # events are stored as unjoined events with limited usage on training and
+            # serving. You can use this method to start a join operation on specified
+            # events with the latest version of product catalog. You can also use this
+            # method to correct events joined with the wrong product catalog. A rejoin
+            # operation can take hours or days to complete.
             rpc :RejoinUserEvents, ::Google::Cloud::Retail::V2::RejoinUserEventsRequest, ::Google::Longrunning::Operation
           end
 

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.10.0"
+        VERSION = "0.12.0"
       end
     end
   end

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

@@ -18,9 +18,11 @@
 
 require "google/cloud/retail/v2/catalog_service"
 require "google/cloud/retail/v2/completion_service"
+require "google/cloud/retail/v2/control_service"
 require "google/cloud/retail/v2/prediction_service"
 require "google/cloud/retail/v2/product_service"
 require "google/cloud/retail/v2/search_service"
+require "google/cloud/retail/v2/serving_config_service"
 require "google/cloud/retail/v2/user_event_service"
 require "google/cloud/retail/v2/version"
 
@@ -28,9 +30,9 @@ module Google
   module Cloud
     module Retail
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/retail/v2"
       #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new