com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1RecommendResponse

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1RecommendResponse

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1RecommendResponse
extends com.google.api.client.json.GenericJson

Response message for Recommend method.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1RecommendResponse()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1RecommendResponse	clone()
String	getAttributionToken() A unique attribution token.
List<String>	getMissingIds() IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
List<GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult>	getResults() A list of recommended Documents.
Boolean	getValidateOnly() True if RecommendRequest.validate_only was set.
GoogleCloudDiscoveryengineV1RecommendResponse	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1RecommendResponse	setAttributionToken(String attributionToken) A unique attribution token.
GoogleCloudDiscoveryengineV1RecommendResponse	setMissingIds(List<String> missingIds) IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
GoogleCloudDiscoveryengineV1RecommendResponse	setResults(List<GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult> results) A list of recommended Documents.
GoogleCloudDiscoveryengineV1RecommendResponse	setValidateOnly(Boolean validateOnly) True if RecommendRequest.validate_only was set.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

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

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

GoogleCloudDiscoveryengineV1RecommendResponse

public GoogleCloudDiscoveryengineV1RecommendResponse()

Method Detail

getAttributionToken

public String getAttributionToken()

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

Returns:

value or null for none

setAttributionToken

public GoogleCloudDiscoveryengineV1RecommendResponse setAttributionToken(String attributionToken)

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

Parameters:

attributionToken - attributionToken or null for none

getMissingIds

public List<String> getMissingIds()

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

Returns:

value or null for none

setMissingIds

public GoogleCloudDiscoveryengineV1RecommendResponse setMissingIds(List<String> missingIds)

IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.

Parameters:

missingIds - missingIds or null for none

getResults

public List<GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult> getResults()

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

Returns:

value or null for none

setResults

public GoogleCloudDiscoveryengineV1RecommendResponse setResults(List<GoogleCloudDiscoveryengineV1RecommendResponseRecommendationResult> results)

A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).

Parameters:

results - results or null for none

getValidateOnly

public Boolean getValidateOnly()

True if RecommendRequest.validate_only was set.

Returns:

value or null for none

setValidateOnly

public GoogleCloudDiscoveryengineV1RecommendResponse setValidateOnly(Boolean validateOnly)

True if RecommendRequest.validate_only was set.

Parameters:

validateOnly - validateOnly or null for none

set

public GoogleCloudDiscoveryengineV1RecommendResponse set(String fieldName,
                                                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1RecommendResponse clone()

Overrides:

clone in class com.google.api.client.json.GenericJson