Class CompleteQueryRequest (2.39.0)

public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder

Autocomplete parameters.

Protobuf type google.cloud.retail.v2alpha.CompleteQueryRequest

Static Fields

CATALOG_FIELD_NUMBER

public static final int CATALOG_FIELD_NUMBER
Field Value
TypeDescription
int

DATASET_FIELD_NUMBER

public static final int DATASET_FIELD_NUMBER
Field Value
TypeDescription
int

DEVICE_TYPE_FIELD_NUMBER

public static final int DEVICE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER

public static final int ENABLE_ATTRIBUTE_SUGGESTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER
Field Value
TypeDescription
int

LANGUAGE_CODES_FIELD_NUMBER

public static final int LANGUAGE_CODES_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_SUGGESTIONS_FIELD_NUMBER

public static final int MAX_SUGGESTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

VISITOR_ID_FIELD_NUMBER

public static final int VISITOR_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CompleteQueryRequest getDefaultInstance()
Returns
TypeDescription
CompleteQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CompleteQueryRequest.Builder newBuilder()
Returns
TypeDescription
CompleteQueryRequest.Builder

newBuilder(CompleteQueryRequest prototype)

public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
Parameter
NameDescription
prototypeCompleteQueryRequest
Returns
TypeDescription
CompleteQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CompleteQueryRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompleteQueryRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompleteQueryRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CompleteQueryRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CompleteQueryRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompleteQueryRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CompleteQueryRequest> parser()
Returns
TypeDescription
Parser<CompleteQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
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:

  • user-data

  • cloud-retail: This option requires enabling auto-learning function first. See guidelines.

string dataset = 6;

Returns
TypeDescription
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;

Returns
TypeDescription
ByteString

The bytes for dataset.

getDefaultInstanceForType()

public CompleteQueryRequest getDefaultInstanceForType()
Returns
TypeDescription
CompleteQueryRequest

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:

  • UNKNOWN_DEVICE_TYPE

  • DESKTOP

  • MOBILE

  • A customized string starts with OTHER_, e.g. OTHER_IPHONE.

string device_type = 4;

Returns
TypeDescription
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:

  • UNKNOWN_DEVICE_TYPE

  • DESKTOP

  • MOBILE

  • A customized string starts with OTHER_, e.g. OTHER_IPHONE.

string device_type = 4;

Returns
TypeDescription
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
TypeDescription
boolean

The enableAttributeSuggestions.

getEntity()

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 to get per-entity autocomplete results.

string entity = 10;

Returns
TypeDescription
String

The entity.

getEntityBytes()

public 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 to get per-entity autocomplete results.

string entity = 10;

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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;

Returns
TypeDescription
ProtocolStringList

A list containing the languageCodes.

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
TypeDescription
int

The maxSuggestions.

getParserForType()

public Parser<CompleteQueryRequest> getParserForType()
Returns
TypeDescription
Parser<CompleteQueryRequest>
Overrides

getQuery()

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];

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for query.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for visitorId.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CompleteQueryRequest.Builder newBuilderForType()
Returns
TypeDescription
CompleteQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CompleteQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CompleteQueryRequest.Builder toBuilder()
Returns
TypeDescription
CompleteQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException