com.influxdb.query.dsl.functions.SampleFlux 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
Specify the Flux query by the Query Builder.
There is a newer version: 7.2.0
/*
 * 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 javax.annotation.Nonnull;

import com.influxdb.query.dsl.Flux;

/**
 * Sample values from a table.
 * See SPEC.
 *
 * 
 * Options
 * 

 * n - Sample every Nth element [int]
 * 
 * pos - Position offset from start of results to begin sampling. pos must be less than n.
 * If pos less than 0, a random offset is used. Default is -1 (random offset) [int].
 * 
 * 
 *
 * 
 * Example
 * 
 * Flux flux = Flux.from("telegraf")
 *     .filter(and(measurement().equal("cpu"), field().equal("usage_system")))
 *     .range(-1L, ChronoUnit.DAYS)
 *     .sample(10);
 *
 * Flux flux = Flux.from("telegraf")
 *     .filter(and(measurement().equal("cpu"), field().equal("usage_system")))
 *     .range(-1L, ChronoUnit.DAYS)
 *     .sample(5, 1);
 * 
 *
 * @author Jakub Bednar (bednar@github) (29/06/2018 07:25)
 */
public final class SampleFlux extends AbstractParametrizedFlux {

    public SampleFlux(@Nonnull final Flux source) {
        super(source);
    }

    @Nonnull
    @Override
    protected String operatorName() {
        return "sample";
    }

    /**
     * @param n Sample every Nth element.
     * @return this
     */
    @Nonnull
    public SampleFlux withN(final int n) {
        withPropertyValue("n", n);

        return this;
    }

    /**
     * @param pos Position offset from start of results to begin sampling. Must be less than @{code n}.
     * @return this
     */
    @Nonnull
    public SampleFlux withPos(final int pos) {
        withPropertyValue("pos", pos);

        return this;
    }
}