Interface SearchRequest.FacetSpecOrBuilder (2.2.3)

Version 2.2.3

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public static interface SearchRequest.FacetSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEnableDynamicPosition()

public abstract 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 by Google Retail Search. It will be ordered together with dynamic facets if dynamic facets is enabled. If set to false, the position of this facet in the response will be the same as in the request, and it will be 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 will be determined by Google Retail Search. 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 enable, which will generate 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 Google Retail Search orders "gender" and "rating" facets. However, notice that "price" and "brands" will always be ranked at 1st and 2nd position since their enable_dynamic_position are false.

bool enable_dynamic_position = 4;

Returns

Type	Description
boolean	The enableDynamicPosition.

getExcludedFilterKeys(int index)

public abstract String getExcludedFilterKeys(int index)

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. For example, suppose there are 100 products with color facet "Red" and 200 products with color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and have "colorFamilies" as FacetKey.key will by default return the "Red" with count 100. If this field contains "colorFamilies", then the query returns both the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string excluded_filter_keys = 3;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The excludedFilterKeys at the given index.

getExcludedFilterKeysBytes(int index)

public abstract ByteString getExcludedFilterKeysBytes(int index)

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. For example, suppose there are 100 products with color facet "Red" and 200 products with color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and have "colorFamilies" as FacetKey.key will by default return the "Red" with count 100. If this field contains "colorFamilies", then the query returns both the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string excluded_filter_keys = 3;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the excludedFilterKeys at the given index.

getExcludedFilterKeysCount()

public abstract int getExcludedFilterKeysCount()

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. For example, suppose there are 100 products with color facet "Red" and 200 products with color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and have "colorFamilies" as FacetKey.key will by default return the "Red" with count 100. If this field contains "colorFamilies", then the query returns both the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string excluded_filter_keys = 3;

Returns

Type	Description
int	The count of excludedFilterKeys.

getExcludedFilterKeysList()

public abstract List<String> getExcludedFilterKeysList()

List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. For example, suppose there are 100 products with color facet "Red" and 200 products with color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and have "colorFamilies" as FacetKey.key will by default return the "Red" with count 100. If this field contains "colorFamilies", then the query returns both the "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" key is now excluded from the filter. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

repeated string excluded_filter_keys = 3;

Returns

Type	Description
List<String>	A list containing the excludedFilterKeys.

getFacetKey()

public abstract SearchRequest.FacetSpec.FacetKey getFacetKey()

Required. The facet key specification.

.google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
SearchRequest.FacetSpec.FacetKey	The facetKey.

getFacetKeyOrBuilder()

public abstract SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()

Required. The facet key specification.

.google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
SearchRequest.FacetSpec.FacetKeyOrBuilder

getLimit()

public abstract int getLimit()

Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 will be coerced to 300. If this field is negative, an INVALID_ARGUMENT is returned.

int32 limit = 2;

Returns

Type	Description
int	The limit.

hasFacetKey()

public abstract boolean hasFacetKey()

Required. The facet key specification.

.google.cloud.retail.v2beta.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the facetKey field is set.