com.influxdb.query.dsl.functions.ToFlux 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 java.util.Collection;
import javax.annotation.Nonnull;

import com.influxdb.query.dsl.Flux;
import com.influxdb.utils.Arguments;

/**
 * The To operation takes data from a stream and writes it to a bucket.
 * See SPEC.
 *
 * 
 * Options
 * 

 *     bucket - The bucket to which data will be written. [string]
 *     bucketID - The bucket to which data will be written. [string]
 *     org - The organization name of the above bucket. [string]
 *     orgID - The organization ID of the above bucket. [string]
 *     host - The remote host to write to. [string]
 *     token - The authorization token to use when writing to a remote host. [string]
 *     timeColumn - The time column of the output. [string]
 *     tagColumns - The tag columns of the output.
 *     fieldFn - Function that takes a record from the input table and returns an object.
 * 
 *
 * 
 * Examples
 * 
 * Flux flux = Flux
 *     .from("telegraf")
 *     .to("my-bucket");
 * 
 *  * Flux flux = Flux
 *     .from("telegraf")
 *     .to("my-bucket", "my-org");
 * 
 *
 * @author Jakub Bednar (10/10/2018 07:58)
 */
public final class ToFlux extends AbstractParametrizedFlux {

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

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

    /**
     * @param bucket The bucket to which data will be written.
     * @return this
     */
    @Nonnull
    public ToFlux withBucket(@Nonnull final String bucket) {

        Arguments.checkNonEmpty(bucket, "bucket");

        this.withPropertyValueEscaped("bucket", bucket);

        return this;
    }

    /**
     * @param bucketID The ID of the bucket to which data will be written.
     * @return this
     */
    @Nonnull
    public ToFlux withBucketID(@Nonnull final String bucketID) {

        Arguments.checkNonEmpty(bucketID, "bucketID");

        this.withPropertyValueEscaped("bucketID", bucketID);

        return this;
    }

    /**
     * @param org The organization name of the above bucket.
     * @return this
     */
    @Nonnull
    public ToFlux withOrg(@Nonnull final String org) {

        Arguments.checkNonEmpty(org, "org");

        this.withPropertyValueEscaped("org", org);

        return this;
    }

    /**
     * @param orgID The organization name of the above bucket.
     * @return this
     */
    @Nonnull
    public ToFlux withOrgID(@Nonnull final String orgID) {

        Arguments.checkNonEmpty(orgID, "orgID");

        this.withPropertyValueEscaped("orgID", orgID);

        return this;
    }

    /**
     * @param host The remote host to write to.
     * @return this
     */
    @Nonnull
    public ToFlux withHost(@Nonnull final String host) {

        Arguments.checkNonEmpty(host, "host");

        this.withPropertyValueEscaped("host", host);

        return this;
    }

    /**
     * @param token The authorization token to use when writing to a remote host.
     * @return this
     */
    @Nonnull
    public ToFlux withToken(@Nonnull final String token) {

        Arguments.checkNonEmpty(token, "token");

        this.withPropertyValueEscaped("token", token);

        return this;
    }

    /**
     * @param timeColumn The time column of the output.
     * @return this
     */
    @Nonnull
    public ToFlux withTimeColumn(@Nonnull final String timeColumn) {

        Arguments.checkNonEmpty(timeColumn, "timeColumn");

        this.withPropertyValueEscaped("timeColumn", timeColumn);

        return this;
    }

    /**
     * @param tagColumns The tag columns of the output.
     * @return this
     */
    @Nonnull
    public ToFlux withTagColumns(@Nonnull final String[] tagColumns) {

        Arguments.checkNotNull(tagColumns, "tagColumns");

        this.withPropertyValue("tagColumns", tagColumns);

        return this;
    }

    /**
     * @param tagColumns The tag columns of the output.
     * @return this
     */
    @Nonnull
    public ToFlux withTagColumns(@Nonnull final Collection tagColumns) {

        Arguments.checkNotNull(tagColumns, "tagColumns");

        this.withPropertyValue("tagColumns", tagColumns);

        return this;
    }

    /**
     * @param fieldFn Function that takes a record from the input table and returns an object.
     * @return this
     */
    @Nonnull
    public ToFlux withFieldFunction(@Nonnull final String fieldFn) {

        Arguments.checkNonEmpty(fieldFn, "fieldFn");

        this.withFunction("fieldFn: (r)", fieldFn);

        return this;
    }
}