com.google.cloud.discoveryengine.v1

Enum SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior

java.lang.Object

java.lang.Enum<SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior>

com.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior>

Enclosing class:

SearchRequest.NaturalLanguageQueryUnderstandingSpec

public static enum SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior
extends Enum<SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior>
implements com.google.protobuf.ProtocolMessageEnum

 Enum describing how extracted filters are applied to the search.
 

Protobuf enum google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters.
HARD_FILTER Applies all extracted filters as hard filters on the results.
SOFT_BOOST Applies all extracted filters as soft boosts.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED_VALUE `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior for extracted filters.
static int	HARD_FILTER_VALUE Applies all extracted filters as hard filters on the results.
static int	SOFT_BOOST_VALUE Applies all extracted filters as soft boosts.

Method Summary

Modifier and Type	Method and Description
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior>	internalGetValueMap()
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED

public static final SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED

 `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior
 for extracted filters. For single datastore search, the default is to
 apply as hard filters. For multi-datastore search, the default is to
 apply as soft boosts.
 

EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED = 0;

HARD_FILTER

public static final SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior HARD_FILTER

 Applies all extracted filters as hard filters on the results. Results
 that do not pass the extracted filters will not be returned in the
 result set.
 

HARD_FILTER = 1;

SOFT_BOOST

public static final SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior SOFT_BOOST

 Applies all extracted filters as soft boosts. Results that pass the
 filters will be boosted up to higher ranks in the result set.
 

SOFT_BOOST = 2;

UNRECOGNIZED

public static final SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior UNRECOGNIZED

Field Detail

EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED_VALUE

public static final int EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED_VALUE

 `EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED` will use the default behavior
 for extracted filters. For single datastore search, the default is to
 apply as hard filters. For multi-datastore search, the default is to
 apply as soft boosts.
 

EXTRACTED_FILTER_BEHAVIOR_UNSPECIFIED = 0;

See Also:

Constant Field Values

HARD_FILTER_VALUE

public static final int HARD_FILTER_VALUE

 Applies all extracted filters as hard filters on the results. Results
 that do not pass the extracted filters will not be returned in the
 result set.
 

HARD_FILTER = 1;

See Also:

Constant Field Values

SOFT_BOOST_VALUE

public static final int SOFT_BOOST_VALUE

 Applies all extracted filters as soft boosts. Results that pass the
 filters will be boosted up to higher ranks in the result set.
 

SOFT_BOOST = 2;

See Also:

Constant Field Values

Method Detail

values

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior c : SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)