Package com.influxdb.query.dsl.functions

Class IntegralFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.IntegralFlux

All Implemented Interfaces:

Expression, HasImports

public final class IntegralFlux
extends AbstractParametrizedFlux

For each aggregate column, it outputs the area under the curve of non null records. The curve is defined as function where the domain is the record times and the range is the record values. See SPEC.

Options

• unit - Time duration to use when computing the integral [duration]

Example

 Flux flux = Flux
     .from("telegraf")
     .integral(1L, ChronoUnit.MINUTES);
 

Author:

Jakub Bednar (bednar@github) (03/07/2018 12:33)

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
IntegralFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
IntegralFlux	withUnit(Long duration, ChronoUnit unit)
IntegralFlux	withUnit(String unit)

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

IntegralFlux

public IntegralFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withUnit

@Nonnull
public IntegralFlux withUnit(@Nonnull
 Long duration,
 @Nonnull
 ChronoUnit unit)

Parameters:

duration - Time duration to use when computing the integral

unit - a ChronoUnit determining how to interpret the duration parameter

Returns:

this

withUnit

@Nonnull
public IntegralFlux withUnit(@Nonnull
 String unit)

Parameters:

unit - Time duration to use when computing the integral

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