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

Class GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec	clone()
String	getField() The field to use for crowding.
Integer	getMaxCount() The maximum number of documents to keep per value of the field.
String	getMode() Mode to use for documents that are crowded away.
GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec	setField(String field) The field to use for crowding.
GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec	setMaxCount(Integer maxCount) The maximum number of documents to keep per value of the field.
GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec	setMode(String mode) Mode to use for documents that are crowded away.

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

GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec()

Method Detail

getField

public String getField()

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

Returns:

value or null for none

setField

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec setField(String field)

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

Parameters:

field - field or null for none

getMaxCount

public Integer getMaxCount()

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.

Returns:

value or null for none

setMaxCount

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec setMaxCount(Integer maxCount)

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are "crowded away". If not specified, the default value is 1.

Parameters:

maxCount - maxCount or null for none

getMode

public String getMode()

Mode to use for documents that are crowded away.

Returns:

value or null for none

setMode

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec setMode(String mode)

Mode to use for documents that are crowded away.

Parameters:

mode - mode or null for none

set

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec set(String fieldName,
                                                                 Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec clone()

Overrides:

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