com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite

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<GoogleCloudDiscoveryengineV1SearchResponse>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs

public class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

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	SearchLite(String servingConfig, GoogleCloudDiscoveryengineV1SearchRequest content) Performs a search.

Method Summary

Modifier and Type	Method and Description
String	getServingConfig() Required.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setServingConfig(String servingConfig) Required.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

SearchLite

protected SearchLite(String servingConfig,
                     GoogleCloudDiscoveryengineV1SearchRequest content)

Performs a search. Similar to the SearchService.Search method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required. Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a `FAILED_PRECONDITION` error is returned. This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use SearchService.Search instead with required OAuth and IAM checks to provide better data security. Create a request for the method "servingConfigs.searchLite". 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.

DiscoveryEngine.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

servingConfig - Required. The resource name of the Search serving config, such as `projects/locations/global/collect ions/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locat ions/global/collections/default_collection/dataStores/default_data_store/servingConfigs/de fault_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

content - the GoogleCloudDiscoveryengineV1SearchRequest

Since:

1.13

Method Detail

set$Xgafv

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setAccessToken

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setAlt

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setCallback

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setFields

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite 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<GoogleCloudDiscoveryengineV1SearchResponse>

setOauthToken

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite 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<GoogleCloudDiscoveryengineV1SearchResponse>

setUploadType

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>

getServingConfig

public String getServingConfig()

Required. The resource name of the Search serving config, such as `projects/locations/global/collec tions/default_collection/engines/servingConfigs/default_serving_config`, or `projects/locations/glo bal/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_con fig`. This field is used to identify the serving configuration name, set of models used to make the search.

setServingConfig

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite setServingConfig(String servingConfig)

Required. The resource name of the Search serving config, such as `projects/locations /global/collections/default_collection/engines/servingConfigs/default_serving_config` , or `projects/locations/global/collections/default_collection/dataStores/default_dat a_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.

set

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.SearchLite set(String parameterName,
                                                                                   Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SearchResponse>