Package com.google.cloud.retail.v2alpha

Enum SearchRequest.SpellCorrectionSpec.Mode

    • Enum Constant Detail

      • 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.retail.v2alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
        MODE_UNSPECIFIED = 0;

      • SUGGESTION_ONLY

        public static final SearchRequest.SpellCorrectionSpec.Mode SUGGESTION_ONLY
         Google Retail Search will try to find a spell suggestion if there
 is any and put in the
 [SearchResponse.corrected_query][google.cloud.retail.v2alpha.SearchResponse.corrected_query].
 The spell suggestion will not be used as the search query.
        SUGGESTION_ONLY = 1;

      • AUTO

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

    • Field Detail

      • 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.retail.v2alpha.SearchRequest.SpellCorrectionSpec.Mode.AUTO].
        MODE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • SUGGESTION_ONLY_VALUE

        public static final int SUGGESTION_ONLY_VALUE
         Google Retail Search will try to find a spell suggestion if there
 is any and put in the
 [SearchResponse.corrected_query][google.cloud.retail.v2alpha.SearchResponse.corrected_query].
 The spell suggestion will not be used as the search query.
        SUGGESTION_ONLY = 1;
        See Also:
        Constant Field Values

      • AUTO_VALUE

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

    • Method Detail

      • values

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

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