Class CollectionOptions.TimeSeriesOptions

java.lang.Object

org.springframework.data.mongodb.core.CollectionOptions.TimeSeriesOptions

Enclosing class:

CollectionOptions

public static class CollectionOptions.TimeSeriesOptions
extends Object

Options applicable to Time Series collections.

Since:

3.3

Author:

Christoph Strobl

See Also:

• https://docs.mongodb.com/manual/core/timeseries-collections

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
CollectionOptions.TimeSeriesOptions	expireAfter(Duration ttl)	Set the Duration for automatic removal of documents older than a specified value.
Duration	getExpireAfter()	Get the Duration for automatic removal of documents.
GranularityDefinition	getGranularity()
@Nullable String	getMetaField()
@Nullable Span	getSpan()	Get the span that defines a bucket.
String	getTimeField()
CollectionOptions.TimeSeriesOptions	granularity(GranularityDefinition granularity)	Select the GranularityDefinition parameter to define how data in the time series collection is organized.
int	hashCode()
CollectionOptions.TimeSeriesOptions	metaField(@Nullable String metaField)	Set the name of the field which contains metadata in each time series document.
CollectionOptions.TimeSeriesOptions	span(@Nullable Span span)	Select the time between timestamps in the same bucket to define how data in the time series collection is organized.
static CollectionOptions.TimeSeriesOptions	timeSeries(String timeField)	Create a new instance of CollectionOptions.TimeSeriesOptions using the given field as its timeField.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

timeSeries

public static CollectionOptions.TimeSeriesOptions timeSeries(String timeField)

Create a new instance of CollectionOptions.TimeSeriesOptions using the given field as its timeField. The one, that contains the date in each time series document.
Annotated fieldnames will be considered during the mapping process.

Parameters:

timeField - must not be null.

Returns:

new instance of CollectionOptions.TimeSeriesOptions.

metaField

@Contract("_ -> new")
public CollectionOptions.TimeSeriesOptions metaField(@Nullable String metaField)

Set the name of the field which contains metadata in each time series document. Should not be the id nor timeSeries(String) timeField} nor point to an array or Collection.
Annotated fieldnames will be considered during the mapping process.

Parameters:

metaField - use null to unset.

Returns:

new instance of CollectionOptions.TimeSeriesOptions.

granularity

@Contract("_ -> new")
public CollectionOptions.TimeSeriesOptions granularity(GranularityDefinition granularity)

Select the GranularityDefinition parameter to define how data in the time series collection is organized. Select one that is closest to the time span between incoming measurements.

Returns:

new instance of CollectionOptions.TimeSeriesOptions.

See Also:

• Granularity

span

@Contract("_ -> new")
public CollectionOptions.TimeSeriesOptions span(@Nullable Span span)

Select the time between timestamps in the same bucket to define how data in the time series collection is organized. Cannot be used in conjunction with granularity(GranularityDefinition).

Parameters:

span - use null to unset.

Returns:

new instance of CollectionOptions.TimeSeriesOptions.

Since:

5.0

See Also:

• Span

expireAfter

@Contract("_ -> new")
public CollectionOptions.TimeSeriesOptions expireAfter(Duration ttl)

Set the Duration for automatic removal of documents older than a specified value.

Parameters:

ttl - must not be null.

Returns:

new instance of CollectionOptions.TimeSeriesOptions.

Since:

4.4

See Also:

• CreateCollectionOptions.expireAfter(long, java.util.concurrent.TimeUnit)

getTimeField

public String getTimeField()

Returns:

never null.

getMetaField

public @Nullable String getMetaField()

Returns:

can be null. Might be an empty String as well, so maybe check via StringUtils.hasText(String).

getGranularity

public GranularityDefinition getGranularity()

Returns:

never null.

getExpireAfter

public Duration getExpireAfter()

Get the Duration for automatic removal of documents.

Returns:

a negative value if not specified.

Since:

4.4

getSpan

public @Nullable Span getSpan()

Get the span that defines a bucket.

Returns:

null if not specified.

Since:

5.0

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object