Package com.influxdb.query.dsl.functions

Class WindowFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.WindowFlux

All Implemented Interfaces:

Expression, HasImports

public final class WindowFlux
extends AbstractParametrizedFlux

Groups the results by a given time range. See SPEC.

Options

• every - Duration of time between windows. Defaults to period's value. [duration]
• period - Duration of the windowed partition. Defaults to every's value. [duration]
• offset - The offset duration relative to the location offset. It can be negative, indicating that the offset goes backwards in time. The default aligns the window boundaries to line up with the now option time. [time]
• timeColumn - Name of the time column to use. Defaults to _time. [string]
• startColumn - Name of the column containing the window start time. Defaults to _start. [string]
• stopColumn - Name of the column containing the window stop time. Defaults to _stop. [string]

Example

 Flux flux = Flux
     .from("telegraf")
     .window(15L, ChronoUnit.MINUTES)
     .max();

 Flux flux = Flux
     .from("telegraf")
     .window(15L, ChronoUnit.MINUTES,
             20L, ChronoUnit.SECONDS,
             1L, ChronoUnit.SECONDS)
     .max();
 

Author:

Jakub Bednar (bednar@github) (27/06/2018 12:01)

Field Summary

Fields inherited from class com.influxdb.query.dsl.Flux

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
WindowFlux(Flux flux)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
WindowFlux	withEvery(Long every, ChronoUnit everyUnit)
WindowFlux	withEvery(String every)
WindowFlux	withOffset(Long offset, ChronoUnit offsetUnit)
WindowFlux	withOffset(String offset)
WindowFlux	withOffset(Instant offset)
WindowFlux	withPeriod(Long period, ChronoUnit periodUnit)
WindowFlux	withPeriod(String period)
WindowFlux	withStartColumn(String startColumn)
WindowFlux	withStopCol(String stopColumn)
WindowFlux	withTimeColumn(String timeColumn)

Methods inherited from class com.influxdb.query.dsl.functions.AbstractParametrizedFlux

appendActual, beforeAppendOperatorName

Methods inherited from class com.influxdb.query.dsl.Flux

addImport, aggregateWindow, aggregateWindow, arrayFrom, arrayFrom, asVariable, columns, columns, count, count, covariance, covariance, covariance, covariance, covariance, covariance, covariance, covariance, covariance, cumulativeSum, cumulativeSum, cumulativeSum, derivative, derivative, difference, difference, difference, difference, difference, difference, distinct, distinct, drop, drop, drop, drop, duplicate, duplicate, elapsed, elapsed, elapsed, elapsed, expression, fill, fill, filter, filter, first, from, from, from, function, getImports, group, groupBy, groupBy, groupBy, groupExcept, groupExcept, groupExcept, integral, integral, interpolateLinear, interpolateLinear, join, join, keep, keep, keep, keep, last, last, limit, limit, limit, map, map, max, max, mean, mean, min, min, pivot, pivot, pivot, quantile, quantile, quantile, quantile, quantile, range, range, range, range, range, range, range, reduce, reduce, rename, rename, rename, sample, sample, sample, set, set, skew, skew, sort, sort, sort, sort, sort, sort, spread, spread, stddev, stddev, sum, sum, tail, tail, tail, timeShift, timeShift, timeShift, timeShift, to, to, to, to, to, to, to, to, toBool, toDuration, toFloat, toInt, toString, toString, toString, toStringConvert, toTime, toUInt, truncateTimeColumn, union, window, window, window, window, window, window, window, withFunction, withFunctionNamed, withPipedFunction, withPropertyNamed, withPropertyNamed, withPropertyValue, withPropertyValue, withPropertyValueEscaped, yield, yield

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

WindowFlux

public WindowFlux(@Nonnull
 Flux flux)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withEvery

@Nonnull
public WindowFlux withEvery(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit)

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

Returns:

this

withEvery

@Nonnull
public WindowFlux withEvery(@Nonnull
 String every)

Parameters:

every - duration of time between windows

Returns:

this

withPeriod

@Nonnull
public WindowFlux withPeriod(@Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit)

Parameters:

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

Returns:

this

withPeriod

@Nonnull
public WindowFlux withPeriod(@Nonnull
 String period)

Parameters:

period - duration of the windowed partition

Returns:

this

withOffset

@Nonnull
public WindowFlux withOffset(@Nonnull
 Long offset,
 @Nonnull
 ChronoUnit offsetUnit)

Parameters:

offset - The offset duration relative to the location offset.

offsetUnit - a ChronoUnit determining how to interpret the offset

Returns:

this

withOffset

@Nonnull
public WindowFlux withOffset(@Nonnull
 Instant offset)

Parameters:

offset - The offset duration relative to the location offset.

Returns:

this

withOffset

@Nonnull
public WindowFlux withOffset(@Nonnull
 String offset)

Parameters:

offset - The offset duration relative to the location offset.

Returns:

this

withTimeColumn

@Nonnull
public WindowFlux withTimeColumn(@Nonnull
 String timeColumn)

Parameters:

timeColumn - name of the time column to use

Returns:

this

withStartColumn

@Nonnull
public WindowFlux withStartColumn(@Nonnull
 String startColumn)

Parameters:

startColumn - name of the column containing the window start time

Returns:

this

withStopCol

@Nonnull
public WindowFlux withStopCol(@Nonnull
 String stopColumn)

Parameters:

stopColumn - name of the column containing the window stop time

Returns:

this

collectImports

public void collectImports(@Nonnull
 Set<String> collectedImports)

Description copied from class: Flux

Collects all imports of the flux.

Overrides:

collectImports in class Flux

Parameters:

collectedImports - a set to be filled by the used imports