Interface CompleteQueryRequestOrBuilder (2.33.0)

public interface CompleteQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCatalog()

public abstract 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 abstract 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 abstract 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
Type	Description
`String`	The dataset.

getDatasetBytes()

public abstract ByteString getDatasetBytes()

Current supported values:

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

string dataset = 6;

Returns
Type	Description
`ByteString`	The bytes for dataset.

getDeviceType()

public abstract 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
Type	Description
`String`	The deviceType.

getDeviceTypeBytes()

public abstract 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
Type	Description
`ByteString`	The bytes for deviceType.

getEntity()

public abstract 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
Type	Description
`String`	The entity.

getEntityBytes()

public abstract ByteString getEntityBytes()

string entity = 10;

Returns
Type	Description
`ByteString`	The bytes for entity.

getLanguageCodes(int index)

public abstract 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 abstract 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.

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 abstract int getLanguageCodesCount()

Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect.

repeated string language_codes = 3;

Returns
Type	Description
`int`	The count of languageCodes.

getLanguageCodesList()

public abstract List<String> getLanguageCodesList()

Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect.

repeated string language_codes = 3;

Returns
Type	Description
`List<String>`	A list containing the languageCodes.

getMaxSuggestions()

public abstract 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.

getQuery()

public abstract 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
Type	Description
`String`	The query.

getQueryBytes()

public abstract 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.

getVisitorId()

public abstract 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 abstract ByteString getVisitorIdBytes()

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.