io.keen.client.java.Timeframe Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of keen-client-api-query Show documentation

Java Query Client API for Keen IO

There is a newer version: 6.0.0

Show newest version

package io.keen.client.java;

import java.util.Map;

/**
 * Interface for Timeframe. For running queries, users can create a
 * Timeframe object to specify the timeframe of a query. Implementing classes must
 * implement constructTimeframeArgs(), which constructs the JSON map to
 * send with the query.
 *
 * @author claireyoung
 * @since 1.0.0
 */
public interface Timeframe {
    /**
     * Subclasses must implement this method to construct
     * the appropriate Timeframe JSON arguments to send for the query.
     *
     * @return  the Timeframe Json map to send in the query.
     */
    Map constructTimeframeArgs();
}