Class SearchRequest.FacetSpec.Builder (0.27.0)

public static final class SearchRequest.FacetSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.FacetSpec.Builder> implements SearchRequest.FacetSpecOrBuilder

A facet specification to perform faceted search.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.FacetSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameter
NameDescription
valuesIterable<String>

The excludedFilterKeys to add.

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameter
NameDescription
valueString

The excludedFilterKeys to add.

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameter
NameDescription
valueByteString

The bytes of the excludedFilterKeys to add.

Returns
TypeDescription
SearchRequest.FacetSpec.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.FacetSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

build()

public SearchRequest.FacetSpec build()
Returns
TypeDescription
SearchRequest.FacetSpec

buildPartial()

public SearchRequest.FacetSpec buildPartial()
Returns
TypeDescription
SearchRequest.FacetSpec

clear()

public SearchRequest.FacetSpec.Builder clear()
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

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

bool enable_dynamic_position = 4;

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Returns
TypeDescription
SearchRequest.FacetSpec.Builder

This builder for chaining.

clearFacetKey()

public SearchRequest.FacetSpec.Builder clearFacetKey()

Required. The facet key specification.

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

Returns
TypeDescription
SearchRequest.FacetSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public SearchRequest.FacetSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

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 are coerced to 300.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 limit = 2;

Returns
TypeDescription
SearchRequest.FacetSpec.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchRequest.FacetSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

clone()

public SearchRequest.FacetSpec.Builder clone()
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

getDefaultInstanceForType()

public SearchRequest.FacetSpec getDefaultInstanceForType()
Returns
TypeDescription
SearchRequest.FacetSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

bool enable_dynamic_position = 4;

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the excludedFilterKeys.

getFacetKey()

public SearchRequest.FacetSpec.FacetKey getFacetKey()

Required. The facet key specification.

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

Returns
TypeDescription
SearchRequest.FacetSpec.FacetKey

The facetKey.

getFacetKeyBuilder()

public SearchRequest.FacetSpec.FacetKey.Builder getFacetKeyBuilder()

Required. The facet key specification.

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

Returns
TypeDescription
SearchRequest.FacetSpec.FacetKey.Builder

getFacetKeyOrBuilder()

public SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()

Required. The facet key specification.

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

Returns
TypeDescription
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 are coerced to 300.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 limit = 2;

Returns
TypeDescription
int

The limit.

hasFacetKey()

public boolean hasFacetKey()

Required. The facet key specification.

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

Returns
TypeDescription
boolean

Whether the facetKey field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)

public SearchRequest.FacetSpec.Builder mergeFacetKey(SearchRequest.FacetSpec.FacetKey value)

Required. The facet key specification.

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

Parameter
NameDescription
valueSearchRequest.FacetSpec.FacetKey
Returns
TypeDescription
SearchRequest.FacetSpec.Builder

mergeFrom(SearchRequest.FacetSpec other)

public SearchRequest.FacetSpec.Builder mergeFrom(SearchRequest.FacetSpec other)
Parameter
NameDescription
otherSearchRequest.FacetSpec
Returns
TypeDescription
SearchRequest.FacetSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.FacetSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchRequest.FacetSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.FacetSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

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

bool enable_dynamic_position = 4;

Parameter
NameDescription
valueboolean

The enableDynamicPosition to set.

Returns
TypeDescription
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 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.

repeated string excluded_filter_keys = 3;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The excludedFilterKeys to set.

Returns
TypeDescription
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.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueSearchRequest.FacetSpec.FacetKey
Returns
TypeDescription
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.discoveryengine.v1.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueSearchRequest.FacetSpec.FacetKey.Builder
Returns
TypeDescription
SearchRequest.FacetSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchRequest.FacetSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

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 are coerced to 300.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 limit = 2;

Parameter
NameDescription
valueint

The limit to set.

Returns
TypeDescription
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)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchRequest.FacetSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchRequest.FacetSpec.Builder
Overrides