com.influxdb.query.dsl.functions.WindowFlux Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of flux-dsl Show documentation
Show all versions of flux-dsl Show documentation
Specify the Flux query by the Query Builder.
/*
* The MIT License
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.influxdb.query.dsl.functions;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import javax.annotation.Nonnull;
import com.influxdb.query.dsl.Flux;
import com.influxdb.utils.Arguments;
/**
* 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)
*/
public final class WindowFlux extends AbstractParametrizedFlux {
public WindowFlux(@Nonnull final Flux flux) {
super(flux);
}
@Nonnull
@Override
protected String operatorName() {
return "window";
}
/**
* @param every duration of time between windows
* @param everyUnit a {@code ChronoUnit} determining how to interpret the {@code every}
* @return this
*/
@Nonnull
public WindowFlux withEvery(@Nonnull final Long every, @Nonnull final ChronoUnit everyUnit) {
Arguments.checkNotNull(every, "Every is required");
Arguments.checkNotNull(everyUnit, "Every ChronoUnit is required");
this.withPropertyValue("every", every, everyUnit);
return this;
}
/**
* @param every duration of time between windows
* @return this
*/
@Nonnull
public WindowFlux withEvery(@Nonnull final String every) {
Arguments.checkDuration(every, "Every");
this.withPropertyValue("every", every);
return this;
}
/**
* @param period duration of the windowed partition
* @param periodUnit a {@code ChronoUnit} determining how to interpret the {@code period}
* @return this
*/
@Nonnull
public WindowFlux withPeriod(@Nonnull final Long period, @Nonnull final ChronoUnit periodUnit) {
Arguments.checkNotNull(period, "Period is required");
Arguments.checkNotNull(periodUnit, "Period ChronoUnit is required");
this.withPropertyValue("period", period, periodUnit);
return this;
}
/**
* @param period duration of the windowed partition
* @return this
*/
@Nonnull
public WindowFlux withPeriod(@Nonnull final String period) {
Arguments.checkDuration(period, "Period");
this.withPropertyValue("period", period);
return this;
}
/**
* @param offset The offset duration relative to the location offset.
* @param offsetUnit a {@code ChronoUnit} determining how to interpret the {@code offset}
* @return this
*/
@Nonnull
public WindowFlux withOffset(@Nonnull final Long offset, @Nonnull final ChronoUnit offsetUnit) {
Arguments.checkNotNull(offset, "Offset is required");
Arguments.checkNotNull(offsetUnit, "Offset ChronoUnit is required");
this.withPropertyValue("offset", offset, offsetUnit);
return this;
}
/**
* @param offset The offset duration relative to the location offset.
* @return this
*/
@Nonnull
public WindowFlux withOffset(@Nonnull final Instant offset) {
Arguments.checkNotNull(offset, "Offset is required");
this.withPropertyValue("offset", offset);
return this;
}
/**
* @param offset The offset duration relative to the location offset.
* @return this
*/
@Nonnull
public WindowFlux withOffset(@Nonnull final String offset) {
Arguments.checkDuration(offset, "offset");
this.withPropertyValue("offset", offset);
return this;
}
/**
* @param timeColumn name of the time column to use
* @return this
*/
@Nonnull
public WindowFlux withTimeColumn(@Nonnull final String timeColumn) {
Arguments.checkNonEmpty(timeColumn, "Time column");
this.withPropertyValueEscaped("timeColumn", timeColumn);
return this;
}
/**
* @param startColumn name of the column containing the window start time
* @return this
*/
@Nonnull
public WindowFlux withStartColumn(@Nonnull final String startColumn) {
Arguments.checkNonEmpty(startColumn, "Start column");
this.withPropertyValueEscaped("startColumn", startColumn);
return this;
}
/**
* @param stopColumn name of the column containing the window stop time
* @return this
*/
@Nonnull
public WindowFlux withStopCol(@Nonnull final String stopColumn) {
Arguments.checkNonEmpty(stopColumn, "Strop column");
this.withPropertyValueEscaped("stopColumn", stopColumn);
return this;
}
}