com.google.cloud.retail.v2alpha

Enum SearchRequest.SpellCorrectionSpec.Mode

java.lang.Object

java.lang.Enum<SearchRequest.SpellCorrectionSpec.Mode>

com.google.cloud.retail.v2alpha.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.retail.v2alpha.SearchRequest.SpellCorrectionSpec.Mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO Automatic spell correction built by Google Retail Search.
MODE_UNSPECIFIED Unspecified spell correction 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].
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_VALUE Automatic spell correction built by Google Retail Search.
static int	MODE_UNSPECIFIED_VALUE Unspecified spell correction mode.
static 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].

Method Summary

Modifier and Type	Method and Description
static SearchRequest.SpellCorrectionSpec.Mode	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.SpellCorrectionSpec.Mode>	internalGetValueMap()
static SearchRequest.SpellCorrectionSpec.Mode	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SearchRequest.SpellCorrectionSpec.Mode	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SearchRequest.SpellCorrectionSpec.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SearchRequest.SpellCorrectionSpec.Mode[]	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

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;

UNRECOGNIZED

public static final SearchRequest.SpellCorrectionSpec.Mode UNRECOGNIZED

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. 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.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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SearchRequest.SpellCorrectionSpec.Mode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)