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

Class GoogleCloudDiscoveryengineV1SearchResponseSearchResult

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.GoogleCloudDiscoveryengineV1SearchResponseSearchResult

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents the search results.

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
GoogleCloudDiscoveryengineV1SearchResponseSearchResult()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	clone()
GoogleCloudDiscoveryengineV1Chunk	getChunk() The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
GoogleCloudDiscoveryengineV1Document	getDocument() The document data snippet in the search response.
String	getId() Document.id of the searched Document.
Map<String,GoogleCloudDiscoveryengineV1DoubleList>	getModelScores() Output only.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	getRankSignals() Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	setChunk(GoogleCloudDiscoveryengineV1Chunk chunk) The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	setDocument(GoogleCloudDiscoveryengineV1Document document) The document data snippet in the search response.
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	setId(String id) Document.id of the searched Document.
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	setModelScores(Map<String,GoogleCloudDiscoveryengineV1DoubleList> modelScores) Output only.
GoogleCloudDiscoveryengineV1SearchResponseSearchResult	setRankSignals(GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals rankSignals) Optional.

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

GoogleCloudDiscoveryengineV1SearchResponseSearchResult

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult()

Method Detail

getChunk

public GoogleCloudDiscoveryengineV1Chunk getChunk()

The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Returns:

value or null for none

setChunk

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult setChunk(GoogleCloudDiscoveryengineV1Chunk chunk)

The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Parameters:

chunk - chunk or null for none

getDocument

public GoogleCloudDiscoveryengineV1Document getDocument()

The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.

Returns:

value or null for none

setDocument

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult setDocument(GoogleCloudDiscoveryengineV1Document document)

The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.

Parameters:

document - document or null for none

getId

public String getId()

Document.id of the searched Document.

Returns:

value or null for none

setId

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult setId(String id)

Document.id of the searched Document.

Parameters:

id - id or null for none

getModelScores

public Map<String,GoogleCloudDiscoveryengineV1DoubleList> getModelScores()

Output only. Google provided available scores.

Returns:

value or null for none

setModelScores

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult setModelScores(Map<String,GoogleCloudDiscoveryengineV1DoubleList> modelScores)

Output only. Google provided available scores.

Parameters:

modelScores - modelScores or null for none

getRankSignals

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals getRankSignals()

Optional. A set of ranking signals associated with the result.

Returns:

value or null for none

setRankSignals

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult setRankSignals(GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals rankSignals)

Optional. A set of ranking signals associated with the result.

Parameters:

rankSignals - rankSignals or null for none

set

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult set(String fieldName,
                                                                  Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1SearchResponseSearchResult clone()

Overrides:

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