Package 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 Details

  • Field Details

    • 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:

    • 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:

    • 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:

  • Method Details

    • values

      public static SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior[] 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

      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.
      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 name
      NullPointerException - if the argument is null

    • 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)
      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 name
      NullPointerException - if the argument is null