Package org.opensearch.protobufs

Enum Class SuggestMode

java.lang.Object

java.lang.Enum<SuggestMode>

org.opensearch.protobufs.SuggestMode

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SuggestMode>, Constable

public enum SuggestMode
extends Enum<SuggestMode>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum org.opensearch.protobufs.SuggestMode

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SUGGEST_MODE_ALWAYS	SUGGEST_MODE_ALWAYS = 1;
SUGGEST_MODE_MISSING	SUGGEST_MODE_MISSING = 2;
SUGGEST_MODE_POPULAR	SUGGEST_MODE_POPULAR = 3;
SUGGEST_MODE_UNSPECIFIED	SUGGEST_MODE_UNSPECIFIED = 0;
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SUGGEST_MODE_ALWAYS_VALUE	SUGGEST_MODE_ALWAYS = 1;
static final int	SUGGEST_MODE_MISSING_VALUE	SUGGEST_MODE_MISSING = 2;
static final int	SUGGEST_MODE_POPULAR_VALUE	SUGGEST_MODE_POPULAR = 3;
static final int	SUGGEST_MODE_UNSPECIFIED_VALUE	SUGGEST_MODE_UNSPECIFIED = 0;

Method Summary

Modifier and Type	Method	Description
static SuggestMode	forNumber(int value)
static final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
final com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
final int	getNumber()
final com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SuggestMode>	internalGetValueMap()
static SuggestMode	valueOf(int value)	Deprecated.
static SuggestMode	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)	Returns the enum constant of this class with the specified name.
static SuggestMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SuggestMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUGGEST_MODE_UNSPECIFIED

public static final SuggestMode SUGGEST_MODE_UNSPECIFIED

SUGGEST_MODE_UNSPECIFIED = 0;

SUGGEST_MODE_ALWAYS

public static final SuggestMode SUGGEST_MODE_ALWAYS

SUGGEST_MODE_ALWAYS = 1;

SUGGEST_MODE_MISSING

public static final SuggestMode SUGGEST_MODE_MISSING

SUGGEST_MODE_MISSING = 2;

SUGGEST_MODE_POPULAR

public static final SuggestMode SUGGEST_MODE_POPULAR

SUGGEST_MODE_POPULAR = 3;

UNRECOGNIZED

public static final SuggestMode UNRECOGNIZED

Field Details

SUGGEST_MODE_UNSPECIFIED_VALUE

public static final int SUGGEST_MODE_UNSPECIFIED_VALUE

SUGGEST_MODE_UNSPECIFIED = 0;

See Also:

• Constant Field Values

SUGGEST_MODE_ALWAYS_VALUE

public static final int SUGGEST_MODE_ALWAYS_VALUE

SUGGEST_MODE_ALWAYS = 1;

See Also:

• Constant Field Values

SUGGEST_MODE_MISSING_VALUE

public static final int SUGGEST_MODE_MISSING_VALUE

SUGGEST_MODE_MISSING = 2;

See Also:

• Constant Field Values

SUGGEST_MODE_POPULAR_VALUE

public static final int SUGGEST_MODE_POPULAR_VALUE

SUGGEST_MODE_POPULAR = 3;

See Also:

• Constant Field Values

Method Details

values

public static SuggestMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SuggestMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 SuggestMode valueOf(int value)

Deprecated.

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

forNumber

public static SuggestMode 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<SuggestMode> 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 SuggestMode valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null