google-cloud-retail-v2 0.10.0 → 0.12.0

data/lib/google/cloud/retail/v2/control_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 ControlService
+          # Credentials for the ControlService 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/control_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 ControlService
+          # Path helper methods for the ControlService 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 Control resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/controls/{control}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            # @param control [String]
+            #
+            # @return [::String]
+            def control_path project:, location:, catalog:, control:
+              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}/controls/#{control}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/retail/v2/control_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/control_service/credentials"
+require "google/cloud/retail/v2/control_service/paths"
+require "google/cloud/retail/v2/control_service/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Service for modifying Control.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/retail/v2/control_service"
+        #     client = ::Google::Cloud::Retail::V2::ControlService::Client.new
+        #
+        module ControlService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "control_service", "helpers.rb"
+require "google/cloud/retail/v2/control_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,57 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/control_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/control_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/control_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.CreateControlRequest" do
+      optional :parent, :string, 1
+      optional :control, :message, 2, "google.cloud.retail.v2.Control"
+      optional :control_id, :string, 3
+    end
+    add_message "google.cloud.retail.v2.UpdateControlRequest" do
+      optional :control, :message, 1, "google.cloud.retail.v2.Control"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.retail.v2.DeleteControlRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.GetControlRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.ListControlsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :filter, :string, 4
+    end
+    add_message "google.cloud.retail.v2.ListControlsResponse" do
+      repeated :controls, :message, 1, "google.cloud.retail.v2.Control"
+      optional :next_page_token, :string, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        CreateControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CreateControlRequest").msgclass
+        UpdateControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateControlRequest").msgclass
+        DeleteControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.DeleteControlRequest").msgclass
+        GetControlRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetControlRequest").msgclass
+        ListControlsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListControlsRequest").msgclass
+        ListControlsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListControlsResponse").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/control_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/control_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module ControlService
+          # Service for modifying Control.
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.ControlService'
+
+            # Creates a Control.
+            #
+            # If the [Control][google.cloud.retail.v2.Control] to create already exists,
+            # an ALREADY_EXISTS error is returned.
+            rpc :CreateControl, ::Google::Cloud::Retail::V2::CreateControlRequest, ::Google::Cloud::Retail::V2::Control
+            # Deletes a Control.
+            #
+            # If the [Control][google.cloud.retail.v2.Control] to delete does not exist,
+            # a NOT_FOUND error is returned.
+            rpc :DeleteControl, ::Google::Cloud::Retail::V2::DeleteControlRequest, ::Google::Protobuf::Empty
+            # Updates a Control.
+            #
+            # [Control][google.cloud.retail.v2.Control] cannot be set to a different
+            # oneof field, if so an INVALID_ARGUMENT is returned. If the
+            # [Control][google.cloud.retail.v2.Control] to update does not exist, a
+            # NOT_FOUND error is returned.
+            rpc :UpdateControl, ::Google::Cloud::Retail::V2::UpdateControlRequest, ::Google::Cloud::Retail::V2::Control
+            # Gets a Control.
+            rpc :GetControl, ::Google::Cloud::Retail::V2::GetControlRequest, ::Google::Cloud::Retail::V2::Control
+            # Lists all Controls by their parent
+            # [Catalog][google.cloud.retail.v2.Catalog].
+            rpc :ListControls, ::Google::Cloud::Retail::V2::ListControlsRequest, ::Google::Cloud::Retail::V2::ListControlsResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -177,7 +177,7 @@ module Google
             #     The ID of the Recommendations AI serving config or placement.
             #     Before you can request predictions from your model, you must create at
             #     least one serving config or placement for it. For more information, see
-            #     [Managing serving configurations]
+            #     [Manage serving configs]
             #     (https://cloud.google.com/retail/docs/manage-configs).
             #
             #     The full list of available serving configs can be seen at
@@ -228,12 +228,11 @@ module Google
             #      * filterOutOfStockItems  tag=(-"promotional")
             #      * filterOutOfStockItems
             #
-            #     If your filter blocks all prediction results, the API will return generic
-            #     (unfiltered) popular products. If you only want results strictly matching
-            #     the filters, set `strictFiltering` to True in `PredictRequest.params` to
-            #     receive empty results instead.
-            #     Note that the API will never return items with storageStatus of "EXPIRED"
-            #     or "DELETED" regardless of filter choices.
+            #     If your filter blocks all prediction results, the API will return *no*
+            #     results. If instead you want empty result sets to return generic
+            #     (unfiltered) popular products, set `strictFiltering` to False in
+            #     `PredictRequest.params`. Note that the API will never return items with
+            #     storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.
             #
             #     If `filterSyntaxV2` is set to true under the `params` field, then
             #     attribute-based expressions are expected instead of the above described
@@ -258,7 +257,7 @@ module Google
             #     * `returnScore`: Boolean. If set to true, the prediction 'score'
             #        corresponding to each returned product will be set in the
             #        `results.metadata` field in the prediction response. The given
-            #        'score' indicates the probability of an product being clicked/purchased
+            #        'score' indicates the probability of a product being clicked/purchased
             #        given the user's context and history.
             #     * `strictFiltering`: Boolean. True by default. If set to false, the service
             #        will return generic (unfiltered) popular products instead of empty if

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

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for making recommendation prediction.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/prediction_service"
         #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new

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

@@ -46,6 +46,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :publish_time, :message, 33, "google.protobuf.Timestamp"
       optional :retrievable_fields, :message, 30, "google.protobuf.FieldMask"
       repeated :variants, :message, 31, "google.cloud.retail.v2.Product"
+      repeated :local_inventories, :message, 35, "google.cloud.retail.v2.LocalInventory"
       oneof :expiration do
         optional :expire_time, :message, 16, "google.protobuf.Timestamp"
         optional :ttl, :message, 17, "google.protobuf.Duration"

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

@@ -782,29 +782,24 @@ module Google
             #   @param errors_config [::Google::Cloud::Retail::V2::ImportErrorsConfig, ::Hash]
             #     The desired location of errors incurred during the Import.
             #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-            #     Indicates which fields in the provided imported 'products' to update. If
-            #     not set, will by default update all fields.
+            #     Indicates which fields in the provided imported `products` to update. If
+            #     not set, all fields are updated.
             #   @param reconciliation_mode [::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode]
             #     The mode of reconciliation between existing products and the products to be
             #     imported. Defaults to
             #     {::Google::Cloud::Retail::V2::ImportProductsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
             #   @param notification_pubsub_topic [::String]
             #     Full Pub/Sub topic name for receiving notification. If this field is set,
-            #     when the import is finished, a notification will be sent to
-            #     specified Pub/Sub topic. The message data will be JSON string of a
+            #     when the import is finished, a notification is sent to
+            #     specified Pub/Sub topic. The message data is JSON string of a
             #     {::Google::Longrunning::Operation Operation}.
             #
             #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
             #     to be within the same project as
             #     {::Google::Cloud::Retail::V2::ImportProductsRequest#parent ImportProductsRequest.parent}.
-            #     Make sure that both
-            #     `cloud-retail-customer-data-access@system.gserviceaccount.com` and
-            #     `service-<project number>@gcp-sa-retail.iam.gserviceaccount.com`
-            #     have the `pubsub.topics.publish` IAM permission on the topic.
-            #
-            #     Only supported when
-            #     {::Google::Cloud::Retail::V2::ImportProductsRequest#reconciliation_mode ImportProductsRequest.reconciliation_mode}
-            #     is set to `FULL`.
+            #     Make sure that `service-<project
+            #     number>@gcp-sa-retail.iam.gserviceaccount.com` has the
+            #     `pubsub.topics.publish` IAM permission on the topic.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -885,9 +880,9 @@ module Google
             #
             # This process is asynchronous and does not require the
             # {::Google::Cloud::Retail::V2::Product Product} to exist before updating
-            # fulfillment information. If the request is valid, the update will be
-            # enqueued and processed downstream. As a consequence, when a response is
-            # returned, updates are not immediately manifested in the
+            # fulfillment information. If the request is valid, the update is enqueued
+            # and processed downstream. As a consequence, when a response is returned,
+            # updates are not immediately manifested in the
             # {::Google::Cloud::Retail::V2::Product Product} queried by
             # {::Google::Cloud::Retail::V2::ProductService::Client#get_product ProductService.GetProduct}
             # or
@@ -897,10 +892,10 @@ module Google
             # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
             # and
             # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct},
-            # the specified inventory field value(s) will overwrite any existing value(s)
+            # the specified inventory field value(s) overwrite any existing value(s)
             # while ignoring the last update time for this field. Furthermore, the last
-            # update time for the specified inventory fields will be overwritten to the
-            # time of the
+            # update times for the specified inventory fields are overwritten by the
+            # times of the
             # {::Google::Cloud::Retail::V2::ProductService::Client#create_product ProductService.CreateProduct}
             # or
             # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
@@ -908,11 +903,11 @@ module Google
             #
             # If no inventory fields are set in
             # {::Google::Cloud::Retail::V2::CreateProductRequest#product CreateProductRequest.product},
-            # then any pre-existing inventory information for this product will be used.
+            # then any pre-existing inventory information for this product is used.
             #
             # If no inventory fields are set in
             # {::Google::Cloud::Retail::V2::SetInventoryRequest#set_mask SetInventoryRequest.set_mask},
-            # then any existing inventory information will be preserved.
+            # then any existing inventory information is preserved.
             #
             # Pre-existing inventory information can only be updated with
             # {::Google::Cloud::Retail::V2::ProductService::Client#set_inventory ProductService.SetInventory},
@@ -920,8 +915,17 @@ module Google
             # and
             # {::Google::Cloud::Retail::V2::ProductService::Client#remove_fulfillment_places ProductService.RemoveFulfillmentPlaces}.
             #
+            # The returned {::Google::Longrunning::Operation Operation}s is obsolete after
+            # one day, and the GetOperation
+            # API returns `NOT_FOUND` afterwards.
+            #
+            # If conflicting updates are issued, the
+            # {::Google::Longrunning::Operation Operation}s associated with the stale
+            # updates are not marked as {::Google::Longrunning::Operation#done done} until
+            # they are obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload set_inventory(request, options = nil)
             #   Pass arguments to `set_inventory` via a request object, either of type
@@ -1103,8 +1107,17 @@ module Google
             # or
             # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
             #
+            # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
+            # after 1 day, and GetOperation
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # {::Google::Longrunning::Operation Operation}s associated with the stale
+            # updates will not be marked as {::Google::Longrunning::Operation#done done}
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload add_fulfillment_places(request, options = nil)
             #   Pass arguments to `add_fulfillment_places` via a request object, either of type
@@ -1264,8 +1277,17 @@ module Google
             # or
             # {::Google::Cloud::Retail::V2::ProductService::Client#list_products ProductService.ListProducts}.
             #
+            # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
+            # after 1 day, and GetOperation
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # {::Google::Longrunning::Operation Operation}s associated with the stale
+            # updates will not be marked as {::Google::Longrunning::Operation#done done}
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload remove_fulfillment_places(request, options = nil)
             #   Pass arguments to `remove_fulfillment_places` via a request object, either of type
@@ -1427,8 +1449,17 @@ module Google
             # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
             # has no effect on local inventories.
             #
+            # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
+            # after 1 day, and GetOperation
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # {::Google::Longrunning::Operation Operation}s associated with the stale
+            # updates will not be marked as {::Google::Longrunning::Operation#done done}
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload add_local_inventories(request, options = nil)
             #   Pass arguments to `add_local_inventories` via a request object, either of type
@@ -1575,8 +1606,17 @@ module Google
             # {::Google::Cloud::Retail::V2::ProductService::Client#update_product ProductService.UpdateProduct}
             # has no effect on local inventories.
             #
+            # The returned {::Google::Longrunning::Operation Operation}s will be obsolete
+            # after 1 day, and GetOperation
+            # API will return NOT_FOUND afterwards.
+            #
+            # If conflicting updates are issued, the
+            # {::Google::Longrunning::Operation Operation}s associated with the stale
+            # updates will not be marked as {::Google::Longrunning::Operation#done done}
+            # until being obsolete.
+            #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload remove_local_inventories(request, options = nil)
             #   Pass arguments to `remove_local_inventories` via a request object, either of type

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

@@ -35,7 +35,7 @@ module Google
         # Service for ingesting {::Google::Cloud::Retail::V2::Product Product} information
         # of the customer's website.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/product_service"
         #     client = ::Google::Cloud::Retail::V2::ProductService::Client.new