Package com.google.cloud.discoveryengine.v1beta

Enum SearchRequest.SpellCorrectionSpec.Mode

java.lang.Object
java.lang.Enum<SearchRequest.SpellCorrectionSpec.Mode>
com.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SearchRequest.SpellCorrectionSpec.Mode>
Enclosing class:
SearchRequest.SpellCorrectionSpec
public static enum SearchRequest.SpellCorrectionSpec.Mode extends Enum<SearchRequest.SpellCorrectionSpec.Mode> implements com.google.protobuf.ProtocolMessageEnum
 Enum describing under which mode spell correction should occur.
Protobuf enum google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode

  • Enum Constant Details

    • MODE_UNSPECIFIED

      public static final SearchRequest.SpellCorrectionSpec.Mode MODE_UNSPECIFIED
       Unspecified spell correction mode. In this case, server behavior
 defaults to
 [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
      MODE_UNSPECIFIED = 0;

    • SUGGESTION_ONLY

      public static final SearchRequest.SpellCorrectionSpec.Mode SUGGESTION_ONLY
       Search API tries to find a spelling suggestion. If a suggestion is
 found, it is put in the
 [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query].
 The spelling suggestion won't be used as the search query.
      SUGGESTION_ONLY = 1;

    • AUTO

      public static final SearchRequest.SpellCorrectionSpec.Mode AUTO
       Automatic spell correction built by the Search API. Search will
 be based on the corrected query if found.
      AUTO = 2;

    • UNRECOGNIZED

      public static final SearchRequest.SpellCorrectionSpec.Mode UNRECOGNIZED

  • Field Details

    • MODE_UNSPECIFIED_VALUE

      public static final int MODE_UNSPECIFIED_VALUE
       Unspecified spell correction mode. In this case, server behavior
 defaults to
 [Mode.AUTO][google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
      MODE_UNSPECIFIED = 0;
      See Also:

    • SUGGESTION_ONLY_VALUE

      public static final int SUGGESTION_ONLY_VALUE
       Search API tries to find a spelling suggestion. If a suggestion is
 found, it is put in the
 [SearchResponse.corrected_query][google.cloud.discoveryengine.v1beta.SearchResponse.corrected_query].
 The spelling suggestion won't be used as the search query.
      SUGGESTION_ONLY = 1;
      See Also:

    • AUTO_VALUE

      public static final int AUTO_VALUE
       Automatic spell correction built by the Search API. Search will
 be based on the corrected query if found.
      AUTO = 2;
      See Also:

  • Method Details

    • values

      public static SearchRequest.SpellCorrectionSpec.Mode[] 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.SpellCorrectionSpec.Mode 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.SpellCorrectionSpec.Mode 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.SpellCorrectionSpec.Mode 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.SpellCorrectionSpec.Mode> 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.SpellCorrectionSpec.Mode 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