public static final class CompleteQueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder> implements CompleteQueryRequestOrBuilder
Autocomplete parameters.Protobuf type
google.cloud.retail.v2beta.CompleteQueryRequest| Modifier and Type | Method and Description |
|---|---|
CompleteQueryRequest.Builder |
addAllLanguageCodes(Iterable<String> values)
Note that this field applies for `user-data` dataset only.
|
CompleteQueryRequest.Builder |
addLanguageCodes(String value)
Note that this field applies for `user-data` dataset only.
|
CompleteQueryRequest.Builder |
addLanguageCodesBytes(com.google.protobuf.ByteString value)
Note that this field applies for `user-data` dataset only.
|
CompleteQueryRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CompleteQueryRequest |
build() |
CompleteQueryRequest |
buildPartial() |
CompleteQueryRequest.Builder |
clear() |
CompleteQueryRequest.Builder |
clearCatalog()
Required.
|
CompleteQueryRequest.Builder |
clearDataset()
Determines which dataset to use for fetching completion.
|
CompleteQueryRequest.Builder |
clearDeviceType()
The device type context for completion suggestions.
|
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.
|
CompleteQueryRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
CompleteQueryRequest.Builder |
clearLanguageCodes()
Note that this field applies for `user-data` dataset only.
|
CompleteQueryRequest.Builder |
clearMaxSuggestions()
Completion max suggestions.
|
CompleteQueryRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
CompleteQueryRequest.Builder |
clearQuery()
Required.
|
CompleteQueryRequest.Builder |
clearVisitorId()
Required field.
|
CompleteQueryRequest.Builder |
clone() |
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.
|
CompleteQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
String |
getQuery()
Required.
|
com.google.protobuf.ByteString |
getQueryBytes()
Required.
|
String |
getVisitorId()
Required field.
|
com.google.protobuf.ByteString |
getVisitorIdBytes()
Required field.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
CompleteQueryRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
CompleteQueryRequest.Builder |
mergeFrom(CompleteQueryRequest other) |
CompleteQueryRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
CompleteQueryRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CompleteQueryRequest.Builder |
setCatalog(String value)
Required.
|
CompleteQueryRequest.Builder |
setCatalogBytes(com.google.protobuf.ByteString value)
Required.
|
CompleteQueryRequest.Builder |
setDataset(String value)
Determines which dataset to use for fetching completion.
|
CompleteQueryRequest.Builder |
setDatasetBytes(com.google.protobuf.ByteString value)
Determines which dataset to use for fetching completion.
|
CompleteQueryRequest.Builder |
setDeviceType(String value)
The device type context for completion suggestions.
|
CompleteQueryRequest.Builder |
setDeviceTypeBytes(com.google.protobuf.ByteString value)
The device type context for completion suggestions.
|
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.
|
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.
|
CompleteQueryRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CompleteQueryRequest.Builder |
setLanguageCodes(int index,
String value)
Note that this field applies for `user-data` dataset only.
|
CompleteQueryRequest.Builder |
setMaxSuggestions(int value)
Completion max suggestions.
|
CompleteQueryRequest.Builder |
setQuery(String value)
Required.
|
CompleteQueryRequest.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
Required.
|
CompleteQueryRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
CompleteQueryRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CompleteQueryRequest.Builder |
setVisitorId(String value)
Required field.
|
CompleteQueryRequest.Builder |
setVisitorIdBytes(com.google.protobuf.ByteString value)
Required field.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CompleteQueryRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CompleteQueryRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CompleteQueryRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(CompleteQueryRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryRequest.Builder>IOExceptionpublic 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 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) = { ... }
value - The catalog to set.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) = { ... }
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) = { ... }
value - The bytes for catalog to set.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];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 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];value - The query to set.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];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];value - The bytes for query to set.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;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 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;value - The visitorId to set.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;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;value - The bytes for visitorId to set.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;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 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;index - The index to set the value at.value - The languageCodes to set.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;value - The languageCodes to add.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;values - The languageCodes to add.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;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;value - The bytes of the languageCodes to add.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 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;value - The deviceType to set.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;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;value - The bytes for deviceType to set.public 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 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.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;value - The dataset to set.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.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;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.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;value - The bytes for dataset to set.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.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 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.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;value - The maxSuggestions to set.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.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;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.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 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.v2beta.UserEvent.entity] to get per-entity autocomplete results.
string entity = 10;value - The entity to set.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.v2beta.UserEvent.entity] to get per-entity autocomplete results.
string entity = 10;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.v2beta.UserEvent.entity] to get per-entity autocomplete results.
string entity = 10;value - The bytes for entity to set.public final CompleteQueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public final CompleteQueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.