com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Answer

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs

public class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Answer
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

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	Answer(String servingConfig, GoogleCloudDiscoveryengineV1AnswerQueryRequest content) Answer query method.

Method Summary

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

Answer

protected Answer(String servingConfig,
                 GoogleCloudDiscoveryengineV1AnswerQueryRequest content)

Answer query method. Create a request for the method "servingConfigs.answer". 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/servingConfigs/default_serving_confi g`. Or the resource name of the agent engine serving config, such as: `projects/locations/ global/collections/default_collection/engines/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) This field is used to identify the serving configuration name, set of models used to make the search.

content - the GoogleCloudDiscoveryengineV1AnswerQueryRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setAccessToken

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

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setAlt

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

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setCallback

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

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setFields

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

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Answer 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<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setOauthToken

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

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setPrettyPrint

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

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Answer 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<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setUploadType

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

setUploadProtocol

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>

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/servingConfigs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/locations/global/collections/d efault_collection/engines/servingConfigs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) 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.Answer 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/servingConf igs/default_serving_config`. Or the resource name of the agent engine serving config, such as: `projects/locations/global/collections/default_collection/engines/servingCon figs/default_agent_answer`. (use when `enable_agent_invocation` set to true, and you have custom `AI_MODE` agent engine configured) 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.Answer set(String parameterName,
                                                                               Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1AnswerQueryResponse>