com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompleteQuery(String dataStore) Completes the specified user input with keyword suggestions.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getDataStore() Required.
Boolean	getIncludeTailSuggestions() Indicates if tail suggestions should be returned if there are no suggestions that match the full query.
String	getQuery() Required.
String	getQueryModel() Specifies the autocomplete data model.
String	getUserPseudoId() Optional.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setDataStore(String dataStore) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setIncludeTailSuggestions(Boolean includeTailSuggestions) Indicates if tail suggestions should be returned if there are no suggestions that match the full query.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setQuery(String query) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setQueryModel(String queryModel) Specifies the autocomplete data model.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setUploadType(String uploadType) Legacy upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	setUserPseudoId(String userPseudoId) Optional.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CompleteQuery

protected CompleteQuery(String dataStore)

Completes the specified user input with keyword suggestions. Create a request for the method "dataStores.completeQuery". This request holds the parameters needed by the the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

CompleteQuery#initialize(com.google.api.client.googleapis.services.Abstra ctGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

dataStore - Required. The parent data store resource name for which the completion is performed, such as `projects/locations/global/collections/default_collection/dataStores/default_data_store`.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setAccessToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setAlt

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setCallback

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setFields

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setKey

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setKey(String key)

Description copied from class: DiscoveryEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setOauthToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setUploadType

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>

getDataStore

public String getDataStore()

Required. The parent data store resource name for which the completion is performed, such as `projects/locations/global/collections/default_collection/dataStores/default_data_store`.

setDataStore

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setDataStore(String dataStore)

Required. The parent data store resource name for which the completion is performed, such as `projects/locations/global/collections/default_collection/dataStores/default_ data_store`.

getIncludeTailSuggestions

public Boolean getIncludeTailSuggestions()

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

setIncludeTailSuggestions

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setIncludeTailSuggestions(Boolean includeTailSuggestions)

Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

getQuery

public String getQuery()

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

setQuery

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setQuery(String query)

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

getQueryModel

public String getQueryModel()

Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.

setQueryModel

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setQueryModel(String queryModel)

Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.

getUserPseudoId

public String getUserPseudoId()

Optional. 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. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

setUserPseudoId

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery setUserPseudoId(String userPseudoId)

Optional. 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. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

set

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery set(String parameterName,
                                                                                   Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1CompleteQueryResponse>