Package org.springframework.data.mongodb.core.timeseries

Enum Class Granularity

java.lang.Object

java.lang.Enum<Granularity>

org.springframework.data.mongodb.core.timeseries.Granularity

All Implemented Interfaces:

Serializable, Comparable<Granularity>, Constable, GranularityDefinition

public enum Granularity
extends Enum<Granularity>
implements GranularityDefinition

Granularities available for Time Series data.

Since:

3.3

Author:

Christoph Strobl

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
DEFAULT	Server default value to indicate no explicit value should be sent.
HOURS	Low frequency ingestion.
MINUTES	Medium frequency ingestion.
SECONDS	High frequency ingestion.

Method Summary

Modifier and Type	Method	Description
static Granularity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Granularity[]	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.springframework.data.mongodb.core.timeseries.GranularityDefinition

name

Enum Constant Details

DEFAULT

public static final Granularity DEFAULT

Server default value to indicate no explicit value should be sent.

SECONDS

public static final Granularity SECONDS

High frequency ingestion.

MINUTES

public static final Granularity MINUTES

Medium frequency ingestion.

HOURS

public static final Granularity HOURS

Low frequency ingestion.

Method Details

values

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