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

Class GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specifies how a facet is computed.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	clone()
Boolean	getCaseInsensitive() True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
List<String>	getContains() Only get facet values that contain the given strings.
List<GoogleCloudDiscoveryengineV1alphaInterval>	getIntervals() Set only if values should be bucketed into intervals.
String	getKey() Required.
String	getOrderBy() The order in which documents are returned.
List<String>	getPrefixes() Only get facet values that start with the given string prefix.
List<String>	getRestrictedValues() Only get facet for the given restricted values.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setCaseInsensitive(Boolean caseInsensitive) True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setContains(List<String> contains) Only get facet values that contain the given strings.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setIntervals(List<GoogleCloudDiscoveryengineV1alphaInterval> intervals) Set only if values should be bucketed into intervals.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setKey(String key) Required.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setOrderBy(String orderBy) The order in which documents are returned.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setPrefixes(List<String> prefixes) Only get facet values that start with the given string prefix.
GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey	setRestrictedValues(List<String> restrictedValues) Only get facet for the given restricted values.

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

GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey()

Method Detail

getCaseInsensitive

public Boolean getCaseInsensitive()

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Returns:

value or null for none

setCaseInsensitive

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setCaseInsensitive(Boolean caseInsensitive)

True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

Parameters:

caseInsensitive - caseInsensitive or null for none

getContains

public List<String> getContains()

Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.

Returns:

value or null for none

setContains

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setContains(List<String> contains)

Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.

Parameters:

contains - contains or null for none

getIntervals

public List<GoogleCloudDiscoveryengineV1alphaInterval> getIntervals()

Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

Returns:

value or null for none

setIntervals

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setIntervals(List<GoogleCloudDiscoveryengineV1alphaInterval> intervals)

Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.

Parameters:

intervals - intervals or null for none

getKey

public String getKey()

Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.

Returns:

value or null for none

setKey

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setKey(String key)

Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.

Parameters:

key - key or null for none

getOrderBy

public String getOrderBy()

The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.

Returns:

value or null for none

setOrderBy

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setOrderBy(String orderBy)

The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.

Parameters:

orderBy - orderBy or null for none

getPrefixes

public List<String> getPrefixes()

Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.

Returns:

value or null for none

setPrefixes

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setPrefixes(List<String> prefixes)

Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.

Parameters:

prefixes - prefixes or null for none

getRestrictedValues

public List<String> getRestrictedValues()

Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.

Returns:

value or null for none

setRestrictedValues

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey setRestrictedValues(List<String> restrictedValues)

Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.

Parameters:

restrictedValues - restrictedValues or null for none

set

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey set(String fieldName,
                                                                           Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey clone()

Overrides:

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