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

Class GoogleCloudDiscoveryengineV1SearchRequestFacetSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A facet specification to perform faceted search.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	clone()
Boolean	getEnableDynamicPosition() Enables dynamic position for this facet.
List<String>	getExcludedFilterKeys() List of keys to exclude when faceting.
GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey	getFacetKey() Required.
Integer	getLimit() Maximum facet values that are returned for this facet.
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	setEnableDynamicPosition(Boolean enableDynamicPosition) Enables dynamic position for this facet.
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	setExcludedFilterKeys(List<String> excludedFilterKeys) List of keys to exclude when faceting.
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	setFacetKey(GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey facetKey) Required.
GoogleCloudDiscoveryengineV1SearchRequestFacetSpec	setLimit(Integer limit) Maximum facet values that are returned for this facet.

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

GoogleCloudDiscoveryengineV1SearchRequestFacetSpec

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec()

Method Detail

getEnableDynamicPosition

public Boolean getEnableDynamicPosition()

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.

Returns:

value or null for none

setEnableDynamicPosition

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec setEnableDynamicPosition(Boolean enableDynamicPosition)

Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.

Parameters:

enableDynamicPosition - enableDynamicPosition or null for none

getExcludedFilterKeys

public List<String> getExcludedFilterKeys()

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.

Returns:

value or null for none

setExcludedFilterKeys

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec setExcludedFilterKeys(List<String> excludedFilterKeys)

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.

Parameters:

excludedFilterKeys - excludedFilterKeys or null for none

getFacetKey

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey getFacetKey()

Required. The facet key specification.

Returns:

value or null for none

setFacetKey

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec setFacetKey(GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey facetKey)

Required. The facet key specification.

Parameters:

facetKey - facetKey or null for none

getLimit

public Integer getLimit()

Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.

Returns:

value or null for none

setLimit

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec setLimit(Integer limit)

Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.

Parameters:

limit - limit or null for none

set

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec set(String fieldName,
                                                              Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1SearchRequestFacetSpec clone()

Overrides:

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