google-cloud-retail-v2 0.10.0 → 0.12.0

data/proto_docs/google/api/client.rb

@@ -0,0 +1,318 @@
+# 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 Api
+    # Required information for every language.
+    # @!attribute [rw] reference_docs_uri
+    #   @return [::String]
+    #     Link to automatically generated reference documentation.  Example:
+    #     https://cloud.google.com/nodejs/docs/reference/asset/latest
+    # @!attribute [rw] destinations
+    #   @return [::Array<::Google::Api::ClientLibraryDestination>]
+    #     The destination where API teams want this client library to be published.
+    class CommonLanguageSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Details about how and where to publish client libraries.
+    # @!attribute [rw] version
+    #   @return [::String]
+    #     Version of the API to apply these settings to.
+    # @!attribute [rw] launch_stage
+    #   @return [::Google::Api::LaunchStage]
+    #     Launch stage of this version of the API.
+    # @!attribute [rw] rest_numeric_enums
+    #   @return [::Boolean]
+    #     When using transport=rest, the client request will encode enums as
+    #     numbers rather than strings.
+    # @!attribute [rw] java_settings
+    #   @return [::Google::Api::JavaSettings]
+    #     Settings for legacy Java features, supported in the Service YAML.
+    # @!attribute [rw] cpp_settings
+    #   @return [::Google::Api::CppSettings]
+    #     Settings for C++ client libraries.
+    # @!attribute [rw] php_settings
+    #   @return [::Google::Api::PhpSettings]
+    #     Settings for PHP client libraries.
+    # @!attribute [rw] python_settings
+    #   @return [::Google::Api::PythonSettings]
+    #     Settings for Python client libraries.
+    # @!attribute [rw] node_settings
+    #   @return [::Google::Api::NodeSettings]
+    #     Settings for Node client libraries.
+    # @!attribute [rw] dotnet_settings
+    #   @return [::Google::Api::DotnetSettings]
+    #     Settings for .NET client libraries.
+    # @!attribute [rw] ruby_settings
+    #   @return [::Google::Api::RubySettings]
+    #     Settings for Ruby client libraries.
+    # @!attribute [rw] go_settings
+    #   @return [::Google::Api::GoSettings]
+    #     Settings for Go client libraries.
+    class ClientLibrarySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # This message configures the settings for publishing [Google Cloud Client
+    # libraries](https://cloud.google.com/apis/docs/cloud-client-libraries)
+    # generated from the service config.
+    # @!attribute [rw] method_settings
+    #   @return [::Array<::Google::Api::MethodSettings>]
+    #     A list of API method settings, e.g. the behavior for methods that use the
+    #     long-running operation pattern.
+    # @!attribute [rw] new_issue_uri
+    #   @return [::String]
+    #     Link to a place that API users can report issues.  Example:
+    #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
+    # @!attribute [rw] documentation_uri
+    #   @return [::String]
+    #     Link to product home page.  Example:
+    #     https://cloud.google.com/asset-inventory/docs/overview
+    # @!attribute [rw] api_short_name
+    #   @return [::String]
+    #     Used as a tracking tag when collecting data about the APIs developer
+    #     relations artifacts like docs, packages delivered to package managers,
+    #     etc.  Example: "speech".
+    # @!attribute [rw] github_label
+    #   @return [::String]
+    #     GitHub label to apply to issues and pull requests opened for this API.
+    # @!attribute [rw] codeowner_github_teams
+    #   @return [::Array<::String>]
+    #     GitHub teams to be added to CODEOWNERS in the directory in GitHub
+    #     containing source code for the client libraries for this API.
+    # @!attribute [rw] doc_tag_prefix
+    #   @return [::String]
+    #     A prefix used in sample code when demarking regions to be included in
+    #     documentation.
+    # @!attribute [rw] organization
+    #   @return [::Google::Api::ClientLibraryOrganization]
+    #     For whom the client library is being published.
+    # @!attribute [rw] library_settings
+    #   @return [::Array<::Google::Api::ClientLibrarySettings>]
+    #     Client library settings.  If the same version string appears multiple
+    #     times in this list, then the last one wins.  Settings from earlier
+    #     settings with the same version string are discarded.
+    class Publishing
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Java client libraries.
+    # @!attribute [rw] library_package
+    #   @return [::String]
+    #     The package name to use in Java. Clobbers the java_package option
+    #     set in the protobuf. This should be used **only** by APIs
+    #     who have already set the language_settings.java.package_name" field
+    #     in gapic.yaml. API teams should use the protobuf java_package option
+    #     where possible.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          library_package: com.google.cloud.pubsub.v1
+    # @!attribute [rw] service_class_names
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Configure the Java class name to use instead of the service's for its
+    #     corresponding generated GAPIC client. Keys are fully-qualified
+    #     service names as they appear in the protobuf (including the full
+    #     the language_settings.java.interface_names" field in gapic.yaml. API
+    #     teams should otherwise use the service name as it appears in the
+    #     protobuf.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        java_settings:
+    #          service_class_names:
+    #            - google.pubsub.v1.Publisher: TopicAdmin
+    #            - google.pubsub.v1.Subscriber: SubscriptionAdmin
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class JavaSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class ServiceClassNamesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # Settings for C++ client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class CppSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Php client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PhpSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Python client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class PythonSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Node client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class NodeSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Dotnet client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class DotnetSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Ruby client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class RubySettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Settings for Go client libraries.
+    # @!attribute [rw] common
+    #   @return [::Google::Api::CommonLanguageSettings]
+    #     Some settings.
+    class GoSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # Describes the generator configuration for a method.
+    # @!attribute [rw] selector
+    #   @return [::String]
+    #     The fully qualified name of the method, for which the options below apply.
+    #     This is used to find the method to apply the options.
+    # @!attribute [rw] long_running
+    #   @return [::Google::Api::MethodSettings::LongRunning]
+    #     Describes settings to use for long-running operations when generating
+    #     API methods for RPCs. Complements RPCs that use the annotations in
+    #     google/longrunning/operations.proto.
+    #
+    #     Example of a YAML configuration::
+    #
+    #      publishing:
+    #        method_behavior:
+    #          - selector: CreateAdDomain
+    #            long_running:
+    #              initial_poll_delay:
+    #                seconds: 60 # 1 minute
+    #              poll_delay_multiplier: 1.5
+    #              max_poll_delay:
+    #                seconds: 360 # 6 minutes
+    #              total_poll_timeout:
+    #                 seconds: 54000 # 90 minutes
+    class MethodSettings
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # Describes settings to use when generating API methods that use the
+      # long-running operation pattern.
+      # All default values below are from those used in the client library
+      # generators (e.g.
+      # [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).
+      # @!attribute [rw] initial_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Initial delay after which the first poll request will be made.
+      #     Default value: 5 seconds.
+      # @!attribute [rw] poll_delay_multiplier
+      #   @return [::Float]
+      #     Multiplier to gradually increase delay between subsequent polls until it
+      #     reaches max_poll_delay.
+      #     Default value: 1.5.
+      # @!attribute [rw] max_poll_delay
+      #   @return [::Google::Protobuf::Duration]
+      #     Maximum time between two subsequent poll requests.
+      #     Default value: 45 seconds.
+      # @!attribute [rw] total_poll_timeout
+      #   @return [::Google::Protobuf::Duration]
+      #     Total polling timeout.
+      #     Default value: 5 minutes.
+      class LongRunning
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+
+    # The organization for which the client libraries are being published.
+    # Affects the url where generated docs are published, etc.
+    module ClientLibraryOrganization
+      # Not useful.
+      CLIENT_LIBRARY_ORGANIZATION_UNSPECIFIED = 0
+
+      # Google Cloud Platform Org.
+      CLOUD = 1
+
+      # Ads (Advertising) Org.
+      ADS = 2
+
+      # Photos Org.
+      PHOTOS = 3
+
+      # Street View Org.
+      STREET_VIEW = 4
+    end
+
+    # To where should client libraries be published?
+    module ClientLibraryDestination
+      # Client libraries will neither be generated nor published to package
+      # managers.
+      CLIENT_LIBRARY_DESTINATION_UNSPECIFIED = 0
+
+      # Generate the client library in a repo under github.com/googleapis,
+      # but don't publish it to package managers.
+      GITHUB = 10
+
+      # Publish the library to package managers like nuget.org and npmjs.com.
+      PACKAGE_MANAGER = 20
+    end
+  end
+end

data/proto_docs/google/api/launch_stage.rb

@@ -0,0 +1,71 @@
+# 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 Api
+    # The launch stage as defined by [Google Cloud Platform
+    # Launch Stages](https://cloud.google.com/terms/launch-stages).
+    module LaunchStage
+      # Do not use this default value.
+      LAUNCH_STAGE_UNSPECIFIED = 0
+
+      # The feature is not yet implemented. Users can not use it.
+      UNIMPLEMENTED = 6
+
+      # Prelaunch features are hidden from users and are only visible internally.
+      PRELAUNCH = 7
+
+      # Early Access features are limited to a closed group of testers. To use
+      # these features, you must sign up in advance and sign a Trusted Tester
+      # agreement (which includes confidentiality provisions). These features may
+      # be unstable, changed in backward-incompatible ways, and are not
+      # guaranteed to be released.
+      EARLY_ACCESS = 1
+
+      # Alpha is a limited availability test for releases before they are cleared
+      # for widespread use. By Alpha, all significant design issues are resolved
+      # and we are in the process of verifying functionality. Alpha customers
+      # need to apply for access, agree to applicable terms, and have their
+      # projects allowlisted. Alpha releases don't have to be feature complete,
+      # no SLAs are provided, and there are no technical support obligations, but
+      # they will be far enough along that customers can actually use them in
+      # test environments or for limited-use tests -- just like they would in
+      # normal production cases.
+      ALPHA = 2
+
+      # Beta is the point at which we are ready to open a release for any
+      # customer to use. There are no SLA or technical support obligations in a
+      # Beta release. Products will be complete from a feature perspective, but
+      # may have some open outstanding issues. Beta releases are suitable for
+      # limited production use cases.
+      BETA = 3
+
+      # GA features are open to all developers and are considered stable and
+      # fully qualified for production use.
+      GA = 4
+
+      # Deprecated features are scheduled to be shut down and removed. For more
+      # information, see the "Deprecation Policy" section of our [Terms of
+      # Service](https://cloud.google.com/terms/)
+      # and the [Google Cloud Platform Subject to the Deprecation
+      # Policy](https://cloud.google.com/terms/deprecation) documentation.
+      DEPRECATED = 5
+    end
+  end
+end

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

@@ -78,6 +78,277 @@ 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 [catalog
+        #     attributes][google.cloud.retail.v2.CatalogAttribute] that are neither in
+        #     use by products nor predefined can be deleted. [Catalog
+        #     attributes][google.cloud.retail.v2.CatalogAttribute] that are
+        #     either in use by products or are predefined attributes 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}.
+        #
+        #     Must be specified, otherwise throws INVALID_FORMAT error.
+        # @!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.
+        #
+        #     Must be specified, otherwise throws INVALID_FORMAT error.
+        # @!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.
+        #
+        #     Must be specified, otherwise throws INVALID_FORMAT error.
+        # @!attribute [rw] exact_searchable_option
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption]
+        #     If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable.
+        #     This property only applies to textual custom attributes and requires
+        #     indexable set to enabled to enable exact-searchable.
+        # @!attribute [rw] retrievable_option
+        #   @return [::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption]
+        #     If RETRIEVABLE_ENABLED, attribute values are retrievable in the search
+        #     results.
+        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.
+            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.
+            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.
+            SEARCHABLE_OPTION_UNSPECIFIED = 0
+
+            # Searchable option enabled for an attribute.
+            SEARCHABLE_ENABLED = 1
+
+            # Searchable option disabled for an attribute.
+            SEARCHABLE_DISABLED = 2
+          end
+
+          # The status of the exact-searchable option of a catalog attribute.
+          module ExactSearchableOption
+            # Value used when unset. Defaults to
+            # {::Google::Cloud::Retail::V2::CatalogAttribute::ExactSearchableOption::EXACT_SEARCHABLE_DISABLED EXACT_SEARCHABLE_DISABLED}.
+            EXACT_SEARCHABLE_OPTION_UNSPECIFIED = 0
+
+            # Exact searchable option enabled for an attribute.
+            EXACT_SEARCHABLE_ENABLED = 1
+
+            # Exact searchable option disabled for an attribute.
+            EXACT_SEARCHABLE_DISABLED = 2
+          end
+
+          # The status of the retrievable option of a catalog attribute.
+          module RetrievableOption
+            # Value used when unset. Defaults to
+            # {::Google::Cloud::Retail::V2::CatalogAttribute::RetrievableOption::RETRIEVABLE_DISABLED RETRIEVABLE_DISABLED}.
+            RETRIEVABLE_OPTION_UNSPECIFIED = 0
+
+            # Retrievable option enabled for an attribute.
+            RETRIEVABLE_ENABLED = 1
+
+            # Retrievable option disabled for an attribute.
+            RETRIEVABLE_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]