public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder
Autocomplete parameters.
Protobuf type google.cloud.retail.v2beta.CompleteQueryRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CATALOG_FIELD_NUMBER
public static final int CATALOG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DATASET_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEVICE_TYPE_FIELD_NUMBER
public static final int DEVICE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER
public static final int ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LANGUAGE_CODES_FIELD_NUMBER
public static final int LANGUAGE_CODES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_SUGGESTIONS_FIELD_NUMBER
public static final int MAX_SUGGESTIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VISITOR_ID_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static CompleteQueryRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static CompleteQueryRequest.Builder newBuilder()
newBuilder(CompleteQueryRequest prototype)
public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static CompleteQueryRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static CompleteQueryRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(CodedInputStream input)
public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(InputStream input)
public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static CompleteQueryRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<CompleteQueryRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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) = { ... }
| Returns |
| Type |
Description |
String |
The catalog.
|
getCatalogBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for catalog.
|
getDataset()
public String getDataset()
Determines which dataset to use for fetching completion. "user-data" will
use the imported dataset through
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:
string dataset = 6;
| Returns |
| Type |
Description |
String |
The dataset.
|
getDatasetBytes()
public ByteString getDatasetBytes()
Determines which dataset to use for fetching completion. "user-data" will
use the imported dataset through
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:
string dataset = 6;
| Returns |
| Type |
Description |
ByteString |
The bytes for dataset.
|
getDefaultInstanceForType()
public CompleteQueryRequest getDefaultInstanceForType()
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:
string device_type = 4;
| Returns |
| Type |
Description |
String |
The deviceType.
|
getDeviceTypeBytes()
public 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:
string device_type = 4;
| Returns |
| Type |
Description |
ByteString |
The bytes for deviceType.
|
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;
| Returns |
| Type |
Description |
boolean |
The enableAttributeSuggestions.
|
getEntity()
public String 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 to get
per-entity autocomplete results.
string entity = 10;
| Returns |
| Type |
Description |
String |
The entity.
|
getEntityBytes()
public 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 to get
per-entity autocomplete results.
string entity = 10;
| Returns |
| Type |
Description |
ByteString |
The bytes for entity.
|
getLanguageCodes(int index)
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. The maximum
number of language codes is 3.
repeated string language_codes = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The languageCodes at the given index.
|
getLanguageCodesBytes(int index)
public 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. The maximum
number of language codes is 3.
repeated string language_codes = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the languageCodes at the given index.
|
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. The maximum
number of language codes is 3.
repeated string language_codes = 3;
| Returns |
| Type |
Description |
int |
The count of languageCodes.
|
getLanguageCodesList()
public 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. The maximum
number of language codes is 3.
repeated string language_codes = 3;
getMaxSuggestions()
public int getMaxSuggestions()
Completion max suggestions. If left unset or set to 0, then will fallback
to the configured value
CompletionConfig.max_suggestions.
The maximum allowed max suggestions is 20. If it is set higher, it will be
capped by 20.
int32 max_suggestions = 5;
| Returns |
| Type |
Description |
int |
The maxSuggestions.
|
getParserForType()
public Parser<CompleteQueryRequest> getParserForType()
Overrides
getQuery()
Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The query.
|
getQueryBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for query.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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;
| Returns |
| Type |
Description |
String |
The visitorId.
|
getVisitorIdBytes()
public 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for visitorId.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public CompleteQueryRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public CompleteQueryRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
