Package com.google.cloud.retail.v2alpha

Class CompleteQueryRequest

  • All Implemented Interfaces:
    CompleteQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CompleteQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements CompleteQueryRequestOrBuilder
     Autocomplete parameters.
    Protobuf type google.cloud.retail.v2alpha.CompleteQueryRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.

      • 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.v2alpha.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.v2alpha.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.

      • 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.v2alpha.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.

      • getEnableAttributeSuggestions

        public boolean getEnableAttributeSuggestions()
         If true, attribute suggestions are enabled and provided in response.

 This field is only available for "cloud-retail" dataset.
        bool enable_attribute_suggestions = 9;
        Specified by:
        getEnableAttributeSuggestions in interface CompleteQueryRequestOrBuilder
        Returns:
        The enableAttributeSuggestions.

      • 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.v2alpha.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.v2alpha.UserEvent.entity] to get
 per-entity autocomplete results.
        string entity = 10;
        Specified by:
        getEntityBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for entity.

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CompleteQueryRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteQueryRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteQueryRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteQueryRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteQueryRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CompleteQueryRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected CompleteQueryRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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

      • getDefaultInstanceForType

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