com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Recommend

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs

public class DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Recommend
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

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	Recommend(String servingConfig, GoogleCloudDiscoveryengineV1RecommendRequest content) Makes a recommendation, which requires a contextual user event.

Method Summary

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

Recommend

protected Recommend(String servingConfig,
                    GoogleCloudDiscoveryengineV1RecommendRequest content)

Makes a recommendation, which requires a contextual user event. Create a request for the method "servingConfigs.recommend". 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. Full resource name of a ServingConfig: `projects/locations/global/collections/engines/servingConfigs`, or `projects/locations/global/collections/dataStores/servingConfigs` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/locations/global/collections/engines/my-engine`, you can use `projects/locations/global/collections/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.

content - the GoogleCloudDiscoveryengineV1RecommendRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setAccessToken

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

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setAlt

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

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setCallback

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

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setFields

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

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Recommend 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<GoogleCloudDiscoveryengineV1RecommendResponse>

setOauthToken

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

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setPrettyPrint

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

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.ServingConfigs.Recommend 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<GoogleCloudDiscoveryengineV1RecommendResponse>

setUploadType

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

setUploadProtocol

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>

getServingConfig

public String getServingConfig()

Required. Full resource name of a ServingConfig: `projects/locations/global/collections/engines/servingConfigs`, or `projects/locations/global/collections/dataStores/servingConfigs` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/locations/global/collections/engines/my- engine`, you can use `projects/locations/global/collections/engines/my-engine/servingConfigs/my- engine` for your RecommendationService.Recommend requests.

setServingConfig

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

Required. Full resource name of a ServingConfig: `projects/locations/global/collections/engines/servingConfigs`, or `projects/locations/global/collections/dataStores/servingConfigs` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/locations/global/collections/engines/my-engine`, you can use `projects/locations/global/collections/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1RecommendResponse>