Package com.google.cloud.retail.v2alpha
Class CompleteQueryRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.CompleteQueryRequest
- All Implemented Interfaces:
CompleteQueryRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class CompleteQueryRequest
extends com.google.protobuf.GeneratedMessage
implements CompleteQueryRequestOrBuilder
Autocomplete parameters.Protobuf type
google.cloud.retail.v2alpha.CompleteQueryRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAutocomplete parameters.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanRequired.com.google.protobuf.ByteStringRequired.Determines which dataset to use for fetching completion.com.google.protobuf.ByteStringDetermines which dataset to use for fetching completion.static CompleteQueryRequeststatic final com.google.protobuf.Descriptors.DescriptorThe device type context for completion suggestions.com.google.protobuf.ByteStringThe device type context for completion suggestions.booleanIf true, attribute suggestions are enabled and provided in the response.The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.com.google.protobuf.ByteStringThe entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc.getLanguageCodes(int index) Note that this field applies for `user-data` dataset only.com.google.protobuf.ByteStringgetLanguageCodesBytes(int index) Note that this field applies for `user-data` dataset only.intNote that this field applies for `user-data` dataset only.com.google.protobuf.ProtocolStringListNote that this field applies for `user-data` dataset only.intCompletion max suggestions.com.google.protobuf.Parser<CompleteQueryRequest>getQuery()Required.com.google.protobuf.ByteStringRequired.intRecommended field.com.google.protobuf.ByteStringRecommended field.inthashCode()protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic CompleteQueryRequest.Builderstatic CompleteQueryRequest.BuildernewBuilder(CompleteQueryRequest prototype) protected CompleteQueryRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static CompleteQueryRequestparseDelimitedFrom(InputStream input) static CompleteQueryRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CompleteQueryRequestparseFrom(byte[] data) static CompleteQueryRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CompleteQueryRequestparseFrom(com.google.protobuf.ByteString data) static CompleteQueryRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CompleteQueryRequestparseFrom(com.google.protobuf.CodedInputStream input) static CompleteQueryRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CompleteQueryRequestparseFrom(InputStream input) static CompleteQueryRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static CompleteQueryRequestparseFrom(ByteBuffer data) static CompleteQueryRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<CompleteQueryRequest>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
CATALOG_FIELD_NUMBER
public static final int CATALOG_FIELD_NUMBER- See Also:
-
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER- See Also:
-
VISITOR_ID_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER- See Also:
-
LANGUAGE_CODES_FIELD_NUMBER
public static final int LANGUAGE_CODES_FIELD_NUMBER- See Also:
-
DEVICE_TYPE_FIELD_NUMBER
public static final int DEVICE_TYPE_FIELD_NUMBER- See Also:
-
DATASET_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER- See Also:
-
MAX_SUGGESTIONS_FIELD_NUMBER
public static final int MAX_SUGGESTIONS_FIELD_NUMBER- See Also:
-
ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER
public static final int ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER- See Also:
-
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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:
getCatalogin interfaceCompleteQueryRequestOrBuilder- 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:
getCatalogBytesin interfaceCompleteQueryRequestOrBuilder- Returns:
- The bytes for catalog.
-
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:
getQueryin interfaceCompleteQueryRequestOrBuilder- 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:
getQueryBytesin interfaceCompleteQueryRequestOrBuilder- Returns:
- The bytes for query.
-
getVisitorId
Recommended 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:
getVisitorIdin interfaceCompleteQueryRequestOrBuilder- Returns:
- The visitorId.
-
getVisitorIdBytes
public com.google.protobuf.ByteString getVisitorIdBytes()Recommended 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:
getVisitorIdBytesin interfaceCompleteQueryRequestOrBuilder- 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:
getLanguageCodesListin interfaceCompleteQueryRequestOrBuilder- 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:
getLanguageCodesCountin interfaceCompleteQueryRequestOrBuilder- Returns:
- The count of languageCodes.
-
getLanguageCodes
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:
getLanguageCodesin interfaceCompleteQueryRequestOrBuilder- 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:
getLanguageCodesBytesin interfaceCompleteQueryRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the languageCodes at the given index.
-
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:
getDeviceTypein interfaceCompleteQueryRequestOrBuilder- 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:
getDeviceTypeBytesin interfaceCompleteQueryRequestOrBuilder- Returns:
- The bytes for deviceType.
-
getDataset
Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through [CompletionService.ImportCompletionData][google.cloud.retail.v2alpha.CompletionService.ImportCompletionData]. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. 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:
getDatasetin interfaceCompleteQueryRequestOrBuilder- Returns:
- The dataset.
-
getDatasetBytes
public com.google.protobuf.ByteString getDatasetBytes()Determines which dataset to use for fetching completion. "user-data" will use the dataset imported through [CompletionService.ImportCompletionData][google.cloud.retail.v2alpha.CompletionService.ImportCompletionData]. `cloud-retail` will use the dataset generated by Cloud Retail based on user events. If left empty, completions will be fetched from the `user-data` dataset. 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:
getDatasetBytesin interfaceCompleteQueryRequestOrBuilder- 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:
getMaxSuggestionsin interfaceCompleteQueryRequestOrBuilder- Returns:
- The maxSuggestions.
-
getEnableAttributeSuggestions
public boolean getEnableAttributeSuggestions()If true, attribute suggestions are enabled and provided in the response. This field is only available for the `cloud-retail` dataset.
bool enable_attribute_suggestions = 9;- Specified by:
getEnableAttributeSuggestionsin interfaceCompleteQueryRequestOrBuilder- Returns:
- The enableAttributeSuggestions.
-
getEntity
The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get per-entity autocomplete results. This field will be applied to `completion_results` only. It has no effect on the `attribute_results`. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.
string entity = 10;- Specified by:
getEntityin interfaceCompleteQueryRequestOrBuilder- Returns:
- The entity.
-
getEntityBytes
public com.google.protobuf.ByteString getEntityBytes()The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with [UserEvent.entity][google.cloud.retail.v2alpha.UserEvent.entity] to get per-entity autocomplete results. This field will be applied to `completion_results` only. It has no effect on the `attribute_results`. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.
string entity = 10;- Specified by:
getEntityBytesin interfaceCompleteQueryRequestOrBuilder- Returns:
- The bytes for entity.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
-
parseFrom
- Throws:
IOException
-
parseFrom
public static CompleteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static CompleteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static CompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static CompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected CompleteQueryRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-