Enum SearchRequest.RelevanceThreshold
java.lang.Object
java.lang.Enum<SearchRequest.RelevanceThreshold>
com.google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<SearchRequest.RelevanceThreshold>
- Enclosing class:
- SearchRequest
public static enum SearchRequest.RelevanceThreshold
extends Enum<SearchRequest.RelevanceThreshold>
implements com.google.protobuf.ProtocolMessageEnum
The relevance threshold of the search results. The higher relevance threshold is, the higher relevant results are shown and the less number of results are returned.Protobuf enum
google.cloud.discoveryengine.v1beta.SearchRequest.RelevanceThreshold-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionHigh relevance threshold.Low relevance threshold.Lowest relevance threshold.Medium relevance threshold.Default value. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intHigh relevance threshold.static final intLow relevance threshold.static final intLowest relevance threshold.static final intMedium relevance threshold.static final intDefault value. -
Method Summary
Modifier and TypeMethodDescriptionforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<SearchRequest.RelevanceThreshold>valueOf(int value) Deprecated.valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.Returns the enum constant of this type with the specified name.static SearchRequest.RelevanceThreshold[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
RELEVANCE_THRESHOLD_UNSPECIFIED
Default value. In this case, server behavior defaults to Google defined threshold.
RELEVANCE_THRESHOLD_UNSPECIFIED = 0; -
LOWEST
Lowest relevance threshold.
LOWEST = 1; -
LOW
Low relevance threshold.
LOW = 2; -
MEDIUM
Medium relevance threshold.
MEDIUM = 3; -
HIGH
High relevance threshold.
HIGH = 4; -
UNRECOGNIZED
-
-
Field Details
-
RELEVANCE_THRESHOLD_UNSPECIFIED_VALUE
public static final int RELEVANCE_THRESHOLD_UNSPECIFIED_VALUEDefault value. In this case, server behavior defaults to Google defined threshold.
RELEVANCE_THRESHOLD_UNSPECIFIED = 0;- See Also:
-
LOWEST_VALUE
public static final int LOWEST_VALUELowest relevance threshold.
LOWEST = 1;- See Also:
-
LOW_VALUE
public static final int LOW_VALUELow relevance threshold.
LOW = 2;- See Also:
-
MEDIUM_VALUE
public static final int MEDIUM_VALUEMedium relevance threshold.
MEDIUM = 3;- See Also:
-
HIGH_VALUE
public static final int HIGH_VALUEHigh relevance threshold.
HIGH = 4;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.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:
value- 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 nameNullPointerException- if the argument is null
-
forNumber
- 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.RelevanceThreshold> internalGetValueMap() -
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static SearchRequest.RelevanceThreshold valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) 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:
desc- 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 nameNullPointerException- if the argument is null
-