Package com.mongodb.client.model

Enum TimeSeriesGranularity

java.lang.Object

java.lang.Enum<TimeSeriesGranularity>

com.mongodb.client.model.TimeSeriesGranularity

All Implemented Interfaces:

Serializable, Comparable<TimeSeriesGranularity>

public enum TimeSeriesGranularity
extends Enum<TimeSeriesGranularity>

An enumeration of time-series data granularity.

It describes the units one would use to describe the expected interval between subsequent measurements for a time-series.

Since:

4.3

See Also:

TimeSeriesOptions, CreateCollectionOptions

Enum Constant Summary

Enum Constants

Enum Constant	Description
HOURS	Hours-level granularity.
MINUTES	Minutes-level granularity.
SECONDS	Seconds-level granularity.

Method Summary

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

SECONDS

public static final TimeSeriesGranularity SECONDS

Seconds-level granularity.

If granularity of a time-series collection is unspecified, this is the default value.

MINUTES

public static final TimeSeriesGranularity MINUTES

Minutes-level granularity.

HOURS

public static final TimeSeriesGranularity HOURS

Hours-level granularity.

Method Detail

values

public static TimeSeriesGranularity[] 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 (TimeSeriesGranularity c : TimeSeriesGranularity.values())
    System.out.println(c);

Returns:

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

valueOf

public static TimeSeriesGranularity 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