public static final class SearchRequest.FacetSpec extends GeneratedMessageV3 implements SearchRequest.FacetSpecOrBuilder
A facet specification to perform faceted search.
Protobuf type google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ENABLE_DYNAMIC_POSITION_FIELD_NUMBER
public static final int ENABLE_DYNAMIC_POSITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXCLUDED_FILTER_KEYS_FIELD_NUMBER
public static final int EXCLUDED_FILTER_KEYS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FACET_KEY_FIELD_NUMBER
public static final int FACET_KEY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LIMIT_FIELD_NUMBER
public static final int LIMIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchRequest.FacetSpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchRequest.FacetSpec.Builder newBuilder()
newBuilder(SearchRequest.FacetSpec prototype)
public static SearchRequest.FacetSpec.Builder newBuilder(SearchRequest.FacetSpec prototype)
public static SearchRequest.FacetSpec parseDelimitedFrom(InputStream input)
public static SearchRequest.FacetSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchRequest.FacetSpec parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.FacetSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchRequest.FacetSpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.FacetSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.FacetSpec parseFrom(CodedInputStream input)
public static SearchRequest.FacetSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.FacetSpec parseFrom(InputStream input)
public static SearchRequest.FacetSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchRequest.FacetSpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest.FacetSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchRequest.FacetSpec> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchRequest.FacetSpec getDefaultInstanceForType()
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 |
| 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 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 |
| 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 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 |
| 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 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 |
| 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 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;
getFacetKey()
public SearchRequest.FacetSpec.FacetKey getFacetKey()
Required. The facet key specification.
.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
getFacetKeyOrBuilder()
public SearchRequest.FacetSpec.FacetKeyOrBuilder getFacetKeyOrBuilder()
Required. The facet key specification.
.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
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.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 limit = 2;
| Returns |
| Type |
Description |
int |
The limit.
|
getParserForType()
public Parser<SearchRequest.FacetSpec> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasFacetKey()
public boolean hasFacetKey()
Required. The facet key specification.
.google.cloud.discoveryengine.v1alpha.SearchRequest.FacetSpec.FacetKey facet_key = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the facetKey field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchRequest.FacetSpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest.FacetSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchRequest.FacetSpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
