- 2.56.0 (latest)
- 2.55.0
- 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 final class SearchRequest.FacetSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder> implements SearchRequest.FacetSpecOrBuilderA facet specification to perform faceted search.
Protobuf type google.cloud.retail.v2.SearchRequest.FacetSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchRequest.FacetSpec.BuilderImplements
SearchRequest.FacetSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllExcludedFilterKeys(Iterable<String> values)
public SearchRequest.FacetSpec.Builder addAllExcludedFilterKeys(Iterable<String> values)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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| values | Iterable<String>The excludedFilterKeys to add. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
addExcludedFilterKeys(String value)
public SearchRequest.FacetSpec.Builder addExcludedFilterKeys(String value)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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| value | StringThe excludedFilterKeys to add. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
addExcludedFilterKeysBytes(ByteString value)
public SearchRequest.FacetSpec.Builder addExcludedFilterKeysBytes(ByteString value)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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| value | ByteStringThe bytes of the excludedFilterKeys to add. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.FacetSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
build()
public SearchRequest.FacetSpec build()| Type | Description |
| SearchRequest.FacetSpec |
buildPartial()
public SearchRequest.FacetSpec buildPartial()| Type | Description |
| SearchRequest.FacetSpec |
clear()
public SearchRequest.FacetSpec.Builder clear()| Type | Description |
| SearchRequest.FacetSpec.Builder |
clearEnableDynamicPosition()
public SearchRequest.FacetSpec.Builder clearEnableDynamicPosition()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;
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
clearExcludedFilterKeys()
public SearchRequest.FacetSpec.Builder clearExcludedFilterKeys()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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
clearFacetKey()
public SearchRequest.FacetSpec.Builder clearFacetKey()Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SearchRequest.FacetSpec.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.FacetSpec.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
clearLimit()
public SearchRequest.FacetSpec.Builder clearLimit()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;
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.FacetSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
clone()
public SearchRequest.FacetSpec.Builder clone()| Type | Description |
| SearchRequest.FacetSpec.Builder |
getDefaultInstanceForType()
public SearchRequest.FacetSpec getDefaultInstanceForType()| Type | Description |
| SearchRequest.FacetSpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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 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;
| Type | Description |
| boolean | The enableDynamicPosition. |
getExcludedFilterKeys(int index)
public 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. 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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The excludedFilterKeys at the given index. |
getExcludedFilterKeysBytes(int index)
public 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. 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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the excludedFilterKeys at the given index. |
getExcludedFilterKeysCount()
public 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. 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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Type | Description |
| int | The count of excludedFilterKeys. |
getExcludedFilterKeysList()
public ProtocolStringList 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. 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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Type | Description |
| ProtocolStringList | A list containing the excludedFilterKeys. |
getFacetKey()
public SearchRequest.FacetSpec.FacetKey getFacetKey()Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SearchRequest.FacetSpec.FacetKey | The facetKey. |
getFacetKeyBuilder()
public SearchRequest.FacetSpec.FacetKey.Builder getFacetKeyBuilder()Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SearchRequest.FacetSpec.FacetKey.Builder |
getFacetKeyOrBuilder()
public SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| SearchRequest.FacetSpec.FacetKeyOrBuilder |
getLimit()
public 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;
| Type | Description |
| int | The limit. |
hasFacetKey()
public boolean hasFacetKey()Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the facetKey field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)
public SearchRequest.FacetSpec.Builder mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | SearchRequest.FacetSpec.FacetKey |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
mergeFrom(SearchRequest.FacetSpec other)
public SearchRequest.FacetSpec.Builder mergeFrom(SearchRequest.FacetSpec other)| Name | Description |
| other | SearchRequest.FacetSpec |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.FacetSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SearchRequest.FacetSpec.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.FacetSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
setEnableDynamicPosition(boolean value)
public SearchRequest.FacetSpec.Builder setEnableDynamicPosition(boolean value)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;
| Name | Description |
| value | booleanThe enableDynamicPosition to set. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
setExcludedFilterKeys(int index, String value)
public SearchRequest.FacetSpec.Builder setExcludedFilterKeys(int index, String value)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 products with the color facet "Red" and 200 products with the color facet "Blue". A query containing the filter "colorFamilies:ANY("Red")" and having "colorFamilies" as FacetKey.key would by default return only "Red" products in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue products available, "Blue" would not be shown as an available facet value. If "colorFamilies" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "colorFamilies" 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" products. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated string excluded_filter_keys = 3;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe excludedFilterKeys to set. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
setFacetKey(SearchRequest.FacetSpec.FacetKey value)
public SearchRequest.FacetSpec.Builder setFacetKey(SearchRequest.FacetSpec.FacetKey value)Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| value | SearchRequest.FacetSpec.FacetKey |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
setFacetKey(SearchRequest.FacetSpec.FacetKey.Builder builderForValue)
public SearchRequest.FacetSpec.Builder setFacetKey(SearchRequest.FacetSpec.FacetKey.Builder builderForValue)Required. The facet key specification.
.google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Name | Description |
| builderForValue | SearchRequest.FacetSpec.FacetKey.Builder |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.FacetSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
setLimit(int value)
public SearchRequest.FacetSpec.Builder setLimit(int value)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;
| Name | Description |
| value | intThe limit to set. |
| Type | Description |
| SearchRequest.FacetSpec.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.FacetSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SearchRequest.FacetSpec.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.FacetSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchRequest.FacetSpec.Builder |