public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder
Auto-complete parameters.
Protobuf type google.cloud.retail.v2.CompleteQueryRequest
Static Fields
CATALOG_FIELD_NUMBER
public static final int CATALOG_FIELD_NUMBER
Field Value
DATASET_FIELD_NUMBER
public static final int DATASET_FIELD_NUMBER
Field Value
DEVICE_TYPE_FIELD_NUMBER
public static final int DEVICE_TYPE_FIELD_NUMBER
Field Value
LANGUAGE_CODES_FIELD_NUMBER
public static final int LANGUAGE_CODES_FIELD_NUMBER
Field Value
MAX_SUGGESTIONS_FIELD_NUMBER
public static final int MAX_SUGGESTIONS_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
VISITOR_ID_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CompleteQueryRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CompleteQueryRequest.Builder newBuilder()
Returns
newBuilder(CompleteQueryRequest prototype)
public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
Parameter
Returns
public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CompleteQueryRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CompleteQueryRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CompleteQueryRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CompleteQueryRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CompleteQueryRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CompleteQueryRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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) = { ... }
| 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) = { ... }
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:
- user-data
- cloud-retail:
This option requires enabling auto-learning function first. See
guidelines.
string dataset = 6;
| 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:
- user-data
- cloud-retail:
This option requires enabling auto-learning function first. See
guidelines.
string dataset = 6;
getDefaultInstanceForType()
public CompleteQueryRequest getDefaultInstanceForType()
Returns
getDeviceType()
public String getDeviceType()
The device type context for completion suggestions.
It is useful to 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_TYPEDESKTOPMOBILE- A customized string starts with
OTHER_, e.g. OTHER_IPHONE.
string device_type = 4;
| Type | Description |
| String | The deviceType.
|
getDeviceTypeBytes()
public ByteString getDeviceTypeBytes()
The device type context for completion suggestions.
It is useful to 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_TYPEDESKTOPMOBILE- A customized string starts with
OTHER_, e.g. OTHER_IPHONE.
string device_type = 4;
| Type | Description |
| ByteString | The bytes for deviceType.
|
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;
| 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;
| 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;
| 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;
| Type | Description |
| int | The maxSuggestions.
|
getParserForType()
public Parser<CompleteQueryRequest> getParserForType()
Returns
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];
| 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];
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CompleteQueryRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CompleteQueryRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
