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

Class GoogleCloudDiscoveryengineV1RankingRecord

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Record message for RankService.Rank 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
GoogleCloudDiscoveryengineV1RankingRecord()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1RankingRecord	clone()
String	getContent() The content of the record.
String	getId() The unique ID to represent the record.
Float	getScore() The score of this record based on the given query and selected model.
String	getTitle() The title of the record.
GoogleCloudDiscoveryengineV1RankingRecord	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1RankingRecord	setContent(String content) The content of the record.
GoogleCloudDiscoveryengineV1RankingRecord	setId(String id) The unique ID to represent the record.
GoogleCloudDiscoveryengineV1RankingRecord	setScore(Float score) The score of this record based on the given query and selected model.
GoogleCloudDiscoveryengineV1RankingRecord	setTitle(String title) The title of the record.

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

GoogleCloudDiscoveryengineV1RankingRecord

public GoogleCloudDiscoveryengineV1RankingRecord()

Method Detail

getContent

public String getContent()

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Returns:

value or null for none

setContent

public GoogleCloudDiscoveryengineV1RankingRecord setContent(String content)

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Parameters:

content - content or null for none

getId

public String getId()

The unique ID to represent the record.

Returns:

value or null for none

setId

public GoogleCloudDiscoveryengineV1RankingRecord setId(String id)

The unique ID to represent the record.

Parameters:

id - id or null for none

getScore

public Float getScore()

The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset.

Returns:

value or null for none

setScore

public GoogleCloudDiscoveryengineV1RankingRecord setScore(Float score)

The score of this record based on the given query and selected model. The score will be rounded to 4 decimal places. If the score is close to 0, it will be rounded to 0.00001 to avoid returning unset.

Parameters:

score - score or null for none

getTitle

public String getTitle()

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Returns:

value or null for none

setTitle

public GoogleCloudDiscoveryengineV1RankingRecord setTitle(String title)

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Parameters:

title - title or null for none

set

public GoogleCloudDiscoveryengineV1RankingRecord set(String fieldName,
                                                     Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1RankingRecord clone()

Overrides:

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