Package com.influxdb.query.dsl.functions

Class TimeShiftFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.TimeShiftFlux

All Implemented Interfaces:

Expression, HasImports

public final class TimeShiftFlux
extends AbstractParametrizedFlux

Shift add a fixed duration to time columns. See SPEC.

Options

• duration - The amount to add to each time value [duration]
• columns - The list of all columns that should be shifted. Defaults `["_start", "_stop", "_time"]` [array of strings].

Example

 Flux flux = Flux
     .from("telegraf")
     .timeShift(10L, ChronoUnit.HOURS);

 Flux flux = Flux
     .from("telegraf")
     .timeShift(10L, ChronoUnit.HOURS, new String[]{"_time", "custom"});
 

Author:

Jakub Bednar (bednar@github) (29/06/2018 10:27)

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
TimeShiftFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
TimeShiftFlux	withColumns(String[] columns)
TimeShiftFlux	withColumns(Collection<String> columns)
TimeShiftFlux	withDuration(Long amount, ChronoUnit unit)
TimeShiftFlux	withDuration(String amount)

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, 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

TimeShiftFlux

public TimeShiftFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withDuration

@Nonnull
public TimeShiftFlux withDuration(@Nonnull
 Long amount,
 @Nonnull
 ChronoUnit unit)

Parameters:

amount - The amount to add to each time value

unit - a ChronoUnit determining how to interpret the amount parameter

Returns:

this

withDuration

@Nonnull
public TimeShiftFlux withDuration(@Nonnull
 String amount)

Parameters:

amount - The amount to add to each time value

Returns:

this

withColumns

@Nonnull
public TimeShiftFlux withColumns(@Nonnull
 String[] columns)

Parameters:

columns - The list of all columns that should be shifted.

Returns:

this

withColumns

@Nonnull
public TimeShiftFlux withColumns(@Nonnull
 Collection<String> columns)

Parameters:

columns - The list of all columns that should be shifted.

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