Package org.opensearch.client.opensearch._types

Enum Class TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.opensearch.client.opensearch._types.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>, Constable, JsonEnum, JsonpSerializable

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public enum TimeUnit
extends Enum<TimeUnit>
implements JsonEnum

Specifies the time units, for example, 5d or 7h. For more information, see Supported units.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
Days
Hours
Microseconds
Milliseconds
Minutes
Nanoseconds
Seconds

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<TimeUnit>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static TimeUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimeUnit[]	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

Methods inherited from interface org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Details

Days

public static final TimeUnit Days

Hours

public static final TimeUnit Hours

Microseconds

public static final TimeUnit Microseconds

Milliseconds

public static final TimeUnit Milliseconds

Minutes

public static final TimeUnit Minutes

Nanoseconds

public static final TimeUnit Nanoseconds

Seconds

public static final TimeUnit Seconds

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<TimeUnit> _DESERIALIZER

Method Details

values

public static TimeUnit[] 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 TimeUnit 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

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum