public final class CompleteQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements CompleteQueryRequestOrBuilder
Autocomplete parameters.Protobuf type
google.cloud.retail.v2beta.CompleteQueryRequest| Modifier and Type | Class and Description |
|---|---|
static class |
CompleteQueryRequest.Builder
Autocomplete parameters.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
CATALOG_FIELD_NUMBER |
static int |
DATASET_FIELD_NUMBER |
static int |
DEVICE_TYPE_FIELD_NUMBER |
static int |
ENTITY_FIELD_NUMBER |
static int |
LANGUAGE_CODES_FIELD_NUMBER |
static int |
MAX_SUGGESTIONS_FIELD_NUMBER |
static int |
QUERY_FIELD_NUMBER |
static int |
VISITOR_ID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
String |
getCatalog()
Required.
|
com.google.protobuf.ByteString |
getCatalogBytes()
Required.
|
String |
getDataset()
Determines which dataset to use for fetching completion.
|
com.google.protobuf.ByteString |
getDatasetBytes()
Determines which dataset to use for fetching completion.
|
static CompleteQueryRequest |
getDefaultInstance() |
CompleteQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDeviceType()
The device type context for completion suggestions.
|
com.google.protobuf.ByteString |
getDeviceTypeBytes()
The device type context for completion suggestions.
|
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.
|
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.
|
String |
getLanguageCodes(int index)
Note that this field applies for `user-data` dataset only.
|
com.google.protobuf.ByteString |
getLanguageCodesBytes(int index)
Note that this field applies for `user-data` dataset only.
|
int |
getLanguageCodesCount()
Note that this field applies for `user-data` dataset only.
|
com.google.protobuf.ProtocolStringList |
getLanguageCodesList()
Note that this field applies for `user-data` dataset only.
|
int |
getMaxSuggestions()
Completion max suggestions.
|
com.google.protobuf.Parser<CompleteQueryRequest> |
getParserForType() |
String |
getQuery()
Required.
|
com.google.protobuf.ByteString |
getQueryBytes()
Required.
|
int |
getSerializedSize() |
String |
getVisitorId()
Required field.
|
com.google.protobuf.ByteString |
getVisitorIdBytes()
Required field.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static CompleteQueryRequest.Builder |
newBuilder() |
static CompleteQueryRequest.Builder |
newBuilder(CompleteQueryRequest prototype) |
CompleteQueryRequest.Builder |
newBuilderForType() |
protected CompleteQueryRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static CompleteQueryRequest |
parseDelimitedFrom(InputStream input) |
static CompleteQueryRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompleteQueryRequest |
parseFrom(byte[] data) |
static CompleteQueryRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompleteQueryRequest |
parseFrom(ByteBuffer data) |
static CompleteQueryRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompleteQueryRequest |
parseFrom(com.google.protobuf.ByteString data) |
static CompleteQueryRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompleteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static CompleteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static CompleteQueryRequest |
parseFrom(InputStream input) |
static CompleteQueryRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<CompleteQueryRequest> |
parser() |
CompleteQueryRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int CATALOG_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER
public static final int LANGUAGE_CODES_FIELD_NUMBER
public static final int DEVICE_TYPE_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER
public static final int MAX_SUGGESTIONS_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }
getCatalog in interface CompleteQueryRequestOrBuilderpublic 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) = { ... }
getCatalogBytes in interface CompleteQueryRequestOrBuilderpublic 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];getQuery in interface CompleteQueryRequestOrBuilderpublic 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];getQueryBytes in interface CompleteQueryRequestOrBuilderpublic 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;getVisitorId in interface CompleteQueryRequestOrBuilderpublic 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;getVisitorIdBytes in interface CompleteQueryRequestOrBuilderpublic 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;getLanguageCodesList in interface CompleteQueryRequestOrBuilderpublic 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;getLanguageCodesCount in interface CompleteQueryRequestOrBuilderpublic 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;getLanguageCodes in interface CompleteQueryRequestOrBuilderindex - The index of the element to return.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;getLanguageCodesBytes in interface CompleteQueryRequestOrBuilderindex - The index of the value to return.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;getDeviceType in interface CompleteQueryRequestOrBuilderpublic 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;getDeviceTypeBytes in interface CompleteQueryRequestOrBuilderpublic String getDataset()
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through [CompletionService.ImportCompletionData][google.cloud.retail.v2beta.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;getDataset in interface CompleteQueryRequestOrBuilderpublic 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.v2beta.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;getDatasetBytes in interface CompleteQueryRequestOrBuilderpublic 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.v2beta.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;getMaxSuggestions in interface CompleteQueryRequestOrBuilderpublic 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.v2beta.UserEvent.entity] to get per-entity autocomplete results.
string entity = 10;getEntity in interface CompleteQueryRequestOrBuilderpublic 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.v2beta.UserEvent.entity] to get per-entity autocomplete results.
string entity = 10;getEntityBytes in interface CompleteQueryRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static CompleteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static CompleteQueryRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static CompleteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CompleteQueryRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static CompleteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static CompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static CompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic CompleteQueryRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static CompleteQueryRequest.Builder newBuilder()
public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
public CompleteQueryRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected CompleteQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static CompleteQueryRequest getDefaultInstance()
public static com.google.protobuf.Parser<CompleteQueryRequest> parser()
public com.google.protobuf.Parser<CompleteQueryRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public CompleteQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.