Package com.google.cloud.retail.v2

Class CompleteQueryRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • clear

        public CompleteQueryRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • getDefaultInstanceForType

        public CompleteQueryRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public CompleteQueryRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public CompleteQueryRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public CompleteQueryRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • setField

        public CompleteQueryRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • clearField

        public CompleteQueryRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • clearOneof

        public CompleteQueryRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • setRepeatedField

        public CompleteQueryRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • addRepeatedField

        public CompleteQueryRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • mergeFrom

        public CompleteQueryRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryRequest.Builder>
        Throws:
        IOException

      • getCatalog

        public String getCatalog()
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getCatalog in interface CompleteQueryRequestOrBuilder
        Returns:
        The catalog.

      • getCatalogBytes

        public com.google.protobuf.ByteString getCatalogBytes()
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getCatalogBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for catalog.

      • setCatalog

        public CompleteQueryRequest.Builder setCatalog​(String value)
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The catalog to set.
        Returns:
        This builder for chaining.

      • clearCatalog

        public CompleteQueryRequest.Builder clearCatalog()
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setCatalogBytes

        public CompleteQueryRequest.Builder setCatalogBytes​(com.google.protobuf.ByteString value)
         Required. Catalog for which the completion is performed.

 Full resource name of catalog, such as
 `projects/*/locations/global/catalogs/default_catalog`.
        string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for catalog to set.
        Returns:
        This builder for chaining.

      • getQuery

        public String getQuery()
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface CompleteQueryRequestOrBuilder
        Returns:
        The query.

      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQueryBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for query.

      • setQuery

        public CompleteQueryRequest.Builder setQuery​(String value)
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.

      • clearQuery

        public CompleteQueryRequest.Builder clearQuery()
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setQueryBytes

        public CompleteQueryRequest.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         Required. The query used to generate suggestions.

 The maximum number of allowed characters is 255.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.

      • getVisitorId

        public String getVisitorId()
         Required field. A unique identifier for tracking visitors. For example,
 this could be implemented with an HTTP cookie, which should be able to
 uniquely identify a visitor on a single device. This unique identifier
 should not change if the visitor logs in or out of the website.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string visitor_id = 7;
        Specified by:
        getVisitorId in interface CompleteQueryRequestOrBuilder
        Returns:
        The visitorId.

      • getVisitorIdBytes

        public com.google.protobuf.ByteString getVisitorIdBytes()
         Required field. A unique identifier for tracking visitors. For example,
 this could be implemented with an HTTP cookie, which should be able to
 uniquely identify a visitor on a single device. This unique identifier
 should not change if the visitor logs in or out of the website.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string visitor_id = 7;
        Specified by:
        getVisitorIdBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for visitorId.

      • setVisitorId

        public CompleteQueryRequest.Builder setVisitorId​(String value)
         Required field. A unique identifier for tracking visitors. For example,
 this could be implemented with an HTTP cookie, which should be able to
 uniquely identify a visitor on a single device. This unique identifier
 should not change if the visitor logs in or out of the website.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string visitor_id = 7;
        Parameters:
        value - The visitorId to set.
        Returns:
        This builder for chaining.

      • clearVisitorId

        public CompleteQueryRequest.Builder clearVisitorId()
         Required field. A unique identifier for tracking visitors. For example,
 this could be implemented with an HTTP cookie, which should be able to
 uniquely identify a visitor on a single device. This unique identifier
 should not change if the visitor logs in or out of the website.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string visitor_id = 7;
        Returns:
        This builder for chaining.

      • setVisitorIdBytes

        public CompleteQueryRequest.Builder setVisitorIdBytes​(com.google.protobuf.ByteString value)
         Required field. A unique identifier for tracking visitors. For example,
 this could be implemented with an HTTP cookie, which should be able to
 uniquely identify a visitor on a single device. This unique identifier
 should not change if the visitor logs in or out of the website.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string visitor_id = 7;
        Parameters:
        value - The bytes for visitorId to set.
        Returns:
        This builder for chaining.

      • getLanguageCodesList

        public com.google.protobuf.ProtocolStringList getLanguageCodesList()
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesList in interface CompleteQueryRequestOrBuilder
        Returns:
        A list containing the languageCodes.

      • getLanguageCodesCount

        public int getLanguageCodesCount()
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesCount in interface CompleteQueryRequestOrBuilder
        Returns:
        The count of languageCodes.

      • getLanguageCodes

        public String getLanguageCodes​(int index)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodes in interface CompleteQueryRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The languageCodes at the given index.

      • getLanguageCodesBytes

        public com.google.protobuf.ByteString getLanguageCodesBytes​(int index)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Specified by:
        getLanguageCodesBytes in interface CompleteQueryRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languageCodes at the given index.

      • setLanguageCodes

        public CompleteQueryRequest.Builder setLanguageCodes​(int index,
                                                     String value)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        index - The index to set the value at.
        value - The languageCodes to set.
        Returns:
        This builder for chaining.

      • addLanguageCodes

        public CompleteQueryRequest.Builder addLanguageCodes​(String value)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        value - The languageCodes to add.
        Returns:
        This builder for chaining.

      • addAllLanguageCodes

        public CompleteQueryRequest.Builder addAllLanguageCodes​(Iterable<String> values)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        values - The languageCodes to add.
        Returns:
        This builder for chaining.

      • clearLanguageCodes

        public CompleteQueryRequest.Builder clearLanguageCodes()
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Returns:
        This builder for chaining.

      • addLanguageCodesBytes

        public CompleteQueryRequest.Builder addLanguageCodesBytes​(com.google.protobuf.ByteString value)
         Note that this field applies for `user-data` dataset only. For requests
 with `cloud-retail` dataset, setting this field has no effect.

 The language filters applied to the output suggestions. If set, it should
 contain the language of the query. If not set, suggestions are returned
 without considering language restrictions. This is the BCP-47 language
 code, such as "en-US" or "sr-Latn". For more information, see [Tags for
 Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
 number of language codes is 3.
        repeated string language_codes = 3;
        Parameters:
        value - The bytes of the languageCodes to add.
        Returns:
        This builder for chaining.

      • getDeviceType

        public String getDeviceType()
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Specified by:
        getDeviceType in interface CompleteQueryRequestOrBuilder
        Returns:
        The deviceType.

      • getDeviceTypeBytes

        public com.google.protobuf.ByteString getDeviceTypeBytes()
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Specified by:
        getDeviceTypeBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for deviceType.

      • setDeviceType

        public CompleteQueryRequest.Builder setDeviceType​(String value)
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Parameters:
        value - The deviceType to set.
        Returns:
        This builder for chaining.

      • clearDeviceType

        public CompleteQueryRequest.Builder clearDeviceType()
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Returns:
        This builder for chaining.

      • setDeviceTypeBytes

        public CompleteQueryRequest.Builder setDeviceTypeBytes​(com.google.protobuf.ByteString value)
         The device type context for completion suggestions. We recommend that you
 leave this field empty.

 It can apply different suggestions on different device types, e.g.
 `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
 types.

 Supported formats:

 * `UNKNOWN_DEVICE_TYPE`

 * `DESKTOP`

 * `MOBILE`

 * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
        string device_type = 4;
        Parameters:
        value - The bytes for deviceType to set.
        Returns:
        This builder for chaining.

      • getDataset

        public String getDataset()
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Specified by:
        getDataset in interface CompleteQueryRequestOrBuilder
        Returns:
        The dataset.

      • getDatasetBytes

        public com.google.protobuf.ByteString getDatasetBytes()
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Specified by:
        getDatasetBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for dataset.

      • setDataset

        public CompleteQueryRequest.Builder setDataset​(String value)
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Parameters:
        value - The dataset to set.
        Returns:
        This builder for chaining.

      • clearDataset

        public CompleteQueryRequest.Builder clearDataset()
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Returns:
        This builder for chaining.

      • setDatasetBytes

        public CompleteQueryRequest.Builder setDatasetBytes​(com.google.protobuf.ByteString value)
         Determines which dataset to use for fetching completion. "user-data" will
 use the imported dataset through
 [CompletionService.ImportCompletionData][google.cloud.retail.v2.CompletionService.ImportCompletionData].
 "cloud-retail" will use the dataset generated by cloud retail based on user
 events. If leave empty, it will use the "user-data".

 Current supported values:

 * user-data

 * cloud-retail:
   This option requires enabling auto-learning function first. See
   [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
        string dataset = 6;
        Parameters:
        value - The bytes for dataset to set.
        Returns:
        This builder for chaining.

      • getMaxSuggestions

        public int getMaxSuggestions()
         Completion max suggestions. If left unset or set to 0, then will fallback
 to the configured value
 [CompletionConfig.max_suggestions][google.cloud.retail.v2.CompletionConfig.max_suggestions].

 The maximum allowed max suggestions is 20. If it is set higher, it will be
 capped by 20.
        int32 max_suggestions = 5;
        Specified by:
        getMaxSuggestions in interface CompleteQueryRequestOrBuilder
        Returns:
        The maxSuggestions.

      • setMaxSuggestions

        public CompleteQueryRequest.Builder setMaxSuggestions​(int value)
         Completion max suggestions. If left unset or set to 0, then will fallback
 to the configured value
 [CompletionConfig.max_suggestions][google.cloud.retail.v2.CompletionConfig.max_suggestions].

 The maximum allowed max suggestions is 20. If it is set higher, it will be
 capped by 20.
        int32 max_suggestions = 5;
        Parameters:
        value - The maxSuggestions to set.
        Returns:
        This builder for chaining.

      • clearMaxSuggestions

        public CompleteQueryRequest.Builder clearMaxSuggestions()
         Completion max suggestions. If left unset or set to 0, then will fallback
 to the configured value
 [CompletionConfig.max_suggestions][google.cloud.retail.v2.CompletionConfig.max_suggestions].

 The maximum allowed max suggestions is 20. If it is set higher, it will be
 capped by 20.
        int32 max_suggestions = 5;
        Returns:
        This builder for chaining.

      • getEntity

        public String getEntity()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Specified by:
        getEntity in interface CompleteQueryRequestOrBuilder
        Returns:
        The entity.

      • getEntityBytes

        public com.google.protobuf.ByteString getEntityBytes()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Specified by:
        getEntityBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for entity.

      • setEntity

        public CompleteQueryRequest.Builder setEntity​(String value)
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Parameters:
        value - The entity to set.
        Returns:
        This builder for chaining.

      • clearEntity

        public CompleteQueryRequest.Builder clearEntity()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Returns:
        This builder for chaining.

      • setEntityBytes

        public CompleteQueryRequest.Builder setEntityBytes​(com.google.protobuf.ByteString value)
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 If this is set, it should be exactly matched with
 [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Parameters:
        value - The bytes for entity to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final CompleteQueryRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>

      • mergeUnknownFields

        public final CompleteQueryRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>