google-cloud-retail-v2 0.8.0 → 0.11.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.
+        #
+        # To load this service and instantiate a 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

@@ -493,9 +493,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

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

@@ -95,6 +95,9 @@ module Google
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors
               )
+
+              # Used by an LRO wrapper for some methods of this service
+              @operations_client = self
             end
 
             # Service calls

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

@@ -7,7 +7,6 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/httpbody_pb'
-require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
 require 'google/cloud/retail/v2/user_event_pb'

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

@@ -50,9 +50,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`.
             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

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.8.0"
+        VERSION = "0.11.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"
 

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

@@ -78,6 +78,239 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Catalog level attribute config for an attribute. For example, if customers
+        # want to enable/disable facet for a specific attribute.
+        # @!attribute [rw] key
+        #   @return [::String]
+        #     Required. Attribute name.
+        #     For example: `color`, `brands`, `attributes.custom_attribute`, such as
+        #     `attributes.xyz`.
+        #     To be indexable, the attribute name can contain only alpha-numeric
+        #     characters and underscores. For example, an attribute named
+        #     `attributes.abc_xyz` can be indexed, but an attribute named
+        #     `attributes.abc-xyz` cannot be indexed.
+        # @!attribute [r] in_use
+        #   @return [::Boolean]
+        #     Output only. Indicates whether this attribute has been used by any
+        #     products. `True` if at least one {::Google::Cloud::Retail::V2::Product Product}
+        #     is using this attribute in
+        #     {::Google::Cloud::Retail::V2::Product#attributes Product.attributes}. Otherwise,
+        #     this field is `False`.
+        #
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute} can be
+        #     pre-loaded by using
+        #     {::Google::Cloud::Retail::V2::CatalogService::Client#add_catalog_attribute CatalogService.AddCatalogAttribute},
+        #     [CatalogService.ImportCatalogAttributes][], or
+        #     {::Google::Cloud::Retail::V2::CatalogService::Client#update_attributes_config CatalogService.UpdateAttributesConfig}
+        #     APIs. This field is `False` for pre-loaded
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s.
+        #
+        #     Only pre-loaded
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s that are
+        #     neither in use by products nor predefined can be deleted.
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute CatalogAttribute}s that are
+        #     either in use by products or are predefined cannot be deleted; however,
+        #     their configuration properties will reset to default values upon removal
+        #     request.
+        #
+        #     After catalog changes, it takes about 10 minutes for this field to update.
+        # @!attribute [r] type
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::AttributeType]
+        #     Output only. The type of this attribute. This is derived from the attribute
+        #     in {::Google::Cloud::Retail::V2::Product#attributes Product.attributes}.
+        # @!attribute [rw] indexable_option
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption]
+        #     When
+        #     {::Google::Cloud::Retail::V2::AttributesConfig#attribute_config_level AttributesConfig.attribute_config_level}
+        #     is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values
+        #     are indexed so that it can be filtered, faceted, or boosted in
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        # @!attribute [rw] dynamic_facetable_option
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption]
+        #     If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic
+        #     facet. Could only be DYNAMIC_FACETABLE_DISABLED if
+        #     {::Google::Cloud::Retail::V2::CatalogAttribute#indexable_option CatalogAttribute.indexable_option}
+        #     is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] searchable_option
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption]
+        #     When
+        #     {::Google::Cloud::Retail::V2::AttributesConfig#attribute_config_level AttributesConfig.attribute_config_level}
+        #     is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values
+        #     are searchable by text queries in
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}.
+        #
+        #     If SEARCHABLE_ENABLED but attribute type is numerical, attribute values
+        #     will not be searchable by text queries in
+        #     {::Google::Cloud::Retail::V2::SearchService::Client#search SearchService.Search}, as
+        #     there are no text values associated to numerical attributes.
+        class CatalogAttribute
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of an attribute.
+          module AttributeType
+            # The type of the attribute is unknown.
+            #
+            # Used when type cannot be derived from attribute that is not
+            # {::Google::Cloud::Retail::V2::CatalogAttribute#in_use in_use}.
+            UNKNOWN = 0
+
+            # Textual attribute.
+            TEXTUAL = 1
+
+            # Numerical attribute.
+            NUMERICAL = 2
+          end
+
+          # The status of the indexable option of a catalog attribute.
+          module IndexableOption
+            # Value used when unset. Defaults to
+            # {::Google::Cloud::Retail::V2::CatalogAttribute::IndexableOption::INDEXABLE_ENABLED INDEXABLE_ENABLED}.
+            INDEXABLE_OPTION_UNSPECIFIED = 0
+
+            # Indexable option enabled for an attribute.
+            INDEXABLE_ENABLED = 1
+
+            # Indexable option disabled for an attribute.
+            INDEXABLE_DISABLED = 2
+          end
+
+          # The status of the dynamic facetable option of a catalog attribute.
+          module DynamicFacetableOption
+            # Value used when unset. Defaults to
+            # {::Google::Cloud::Retail::V2::CatalogAttribute::DynamicFacetableOption::DYNAMIC_FACETABLE_ENABLED DYNAMIC_FACETABLE_ENABLED}.
+            DYNAMIC_FACETABLE_OPTION_UNSPECIFIED = 0
+
+            # Dynamic facetable option enabled for an attribute.
+            DYNAMIC_FACETABLE_ENABLED = 1
+
+            # Dynamic facetable option disabled for an attribute.
+            DYNAMIC_FACETABLE_DISABLED = 2
+          end
+
+          # The status of the searchable option of a catalog attribute.
+          module SearchableOption
+            # Value used when unset. Defaults to
+            # {::Google::Cloud::Retail::V2::CatalogAttribute::SearchableOption::SEARCHABLE_DISABLED SEARCHABLE_DISABLED}.
+            SEARCHABLE_OPTION_UNSPECIFIED = 0
+
+            # Searchable option enabled for an attribute.
+            SEARCHABLE_ENABLED = 1
+
+            # Searchable option disabled for an attribute.
+            SEARCHABLE_DISABLED = 2
+          end
+        end
+
+        # Catalog level attribute config.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Immutable. The fully qualified resource name of the attribute
+        #     config. Format: `projects/*/locations/*/catalogs/*/attributesConfig`
+        # @!attribute [rw] catalog_attributes
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CatalogAttribute}]
+        #     Enable attribute(s) config at catalog level.
+        #     For example, indexable, dynamic_facetable, or searchable for each
+        #     attribute.
+        #
+        #     The key is catalog attribute's name.
+        #     For example: `color`, `brands`, `attributes.custom_attribute`, such as
+        #     `attributes.xyz`.
+        #
+        #     The maximum number of catalog attributes allowed in a request is 1000.
+        # @!attribute [r] attribute_config_level
+        #   @return [::Google::Cloud::Retail::V2::AttributeConfigLevel]
+        #     Output only. The
+        #     {::Google::Cloud::Retail::V2::AttributeConfigLevel AttributeConfigLevel} used
+        #     for this catalog.
+        class AttributesConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Retail::V2::CatalogAttribute]
+          class CatalogAttributesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Catalog level autocomplete config for customers to customize autocomplete
+        # feature's settings.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Immutable. Fully qualified name
+        #     `projects/*/locations/*/catalogs/*/completionConfig`
+        # @!attribute [rw] matching_order
+        #   @return [::String]
+        #     Specifies the matching order for autocomplete suggestions, e.g., a query
+        #     consisting of 'sh' with 'out-of-order' specified would suggest "women's
+        #     shoes", whereas a query of 'red s' with 'exact-prefix' specified would
+        #     suggest "red shoes". Currently supported values:
+        #
+        #     * 'out-of-order'
+        #     * 'exact-prefix'
+        #
+        #     Default value: 'exact-prefix'.
+        # @!attribute [rw] max_suggestions
+        #   @return [::Integer]
+        #     The maximum number of autocomplete suggestions returned per term. Default
+        #     value is 20. If left unset or set to 0, then will fallback to default
+        #     value.
+        #
+        #     Value range is 1 to 20.
+        # @!attribute [rw] min_prefix_length
+        #   @return [::Integer]
+        #     The minimum number of characters needed to be typed in order to get
+        #     suggestions. Default value is 2. If left unset or set to 0, then will
+        #     fallback to default value.
+        #
+        #     Value range is 1 to 20.
+        # @!attribute [rw] auto_learning
+        #   @return [::Boolean]
+        #     If set to true, the auto learning function is enabled. Auto learning uses
+        #     user data to generate suggestions using ML techniques. Default value is
+        #     false. Only after enabling auto learning can users use `cloud-retail`
+        #     data in
+        #     {::Google::Cloud::Retail::V2::CompleteQueryRequest CompleteQueryRequest}.
+        # @!attribute [r] suggestions_input_config
+        #   @return [::Google::Cloud::Retail::V2::CompletionDataInputConfig]
+        #     Output only. The source data for the latest import of the autocomplete
+        #     suggestion phrases.
+        # @!attribute [r] last_suggestions_import_operation
+        #   @return [::String]
+        #     Output only. Name of the LRO corresponding to the latest suggestion terms
+        #     list import.
+        #
+        #     Can use GetOperation API to
+        #     retrieve the latest state of the Long Running Operation.
+        # @!attribute [r] denylist_input_config
+        #   @return [::Google::Cloud::Retail::V2::CompletionDataInputConfig]
+        #     Output only. The source data for the latest import of the autocomplete
+        #     denylist phrases.
+        # @!attribute [r] last_denylist_import_operation
+        #   @return [::String]
+        #     Output only. Name of the LRO corresponding to the latest denylist import.
+        #
+        #     Can use GetOperation API to
+        #     retrieve the latest state of the Long Running Operation.
+        # @!attribute [r] allowlist_input_config
+        #   @return [::Google::Cloud::Retail::V2::CompletionDataInputConfig]
+        #     Output only. The source data for the latest import of the autocomplete
+        #     allowlist phrases.
+        # @!attribute [r] last_allowlist_import_operation
+        #   @return [::String]
+        #     Output only. Name of the LRO corresponding to the latest allowlist import.
+        #
+        #     Can use GetOperation API to
+        #     retrieve the latest state of the Long Running Operation.
+        class CompletionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The catalog configuration.
         # @!attribute [rw] name
         #   @return [::String]