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

Class GoogleCloudDiscoveryengineV1ControlBoostAction

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Adjusts order of products in returned list.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1ControlBoostAction	clone()
Float	getBoost() Strength of the boost, which should be in [-1, 1].
String	getDataStore() Required.
String	getFilter() Required.
Float	getFixedBoost() Optional.
GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec	getInterpolationBoostSpec() Optional.
GoogleCloudDiscoveryengineV1ControlBoostAction	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1ControlBoostAction	setBoost(Float boost) Strength of the boost, which should be in [-1, 1].
GoogleCloudDiscoveryengineV1ControlBoostAction	setDataStore(String dataStore) Required.
GoogleCloudDiscoveryengineV1ControlBoostAction	setFilter(String filter) Required.
GoogleCloudDiscoveryengineV1ControlBoostAction	setFixedBoost(Float fixedBoost) Optional.
GoogleCloudDiscoveryengineV1ControlBoostAction	setInterpolationBoostSpec(GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec interpolationBoostSpec) 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

GoogleCloudDiscoveryengineV1ControlBoostAction

public GoogleCloudDiscoveryengineV1ControlBoostAction()

Method Detail

getBoost

public Float getBoost()

Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Returns:

value or null for none

setBoost

public GoogleCloudDiscoveryengineV1ControlBoostAction setBoost(Float boost)

Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Parameters:

boost - boost or null for none

getDataStore

public String getDataStore()

Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

Returns:

value or null for none

setDataStore

public GoogleCloudDiscoveryengineV1ControlBoostAction setDataStore(String dataStore)

Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store

Parameters:

dataStore - dataStore or null for none

getFilter

public String getFilter()

Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and- order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

value or null for none

setFilter

public GoogleCloudDiscoveryengineV1ControlBoostAction setFilter(String filter)

Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and- order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

Parameters:

filter - filter or null for none

getFixedBoost

public Float getFixedBoost()

Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Returns:

value or null for none

setFixedBoost

public GoogleCloudDiscoveryengineV1ControlBoostAction setFixedBoost(Float fixedBoost)

Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Parameters:

fixedBoost - fixedBoost or null for none

getInterpolationBoostSpec

public GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec getInterpolationBoostSpec()

Optional. Complex specification for custom ranking based on customer defined attribute value.

Returns:

value or null for none

setInterpolationBoostSpec

public GoogleCloudDiscoveryengineV1ControlBoostAction setInterpolationBoostSpec(GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec interpolationBoostSpec)

Optional. Complex specification for custom ranking based on customer defined attribute value.

Parameters:

interpolationBoostSpec - interpolationBoostSpec or null for none

set

public GoogleCloudDiscoveryengineV1ControlBoostAction set(String fieldName,
                                                          Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1ControlBoostAction clone()

Overrides:

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