Package org.kairosdb.client.builder

Class AbstractQueryBuilder<B extends AbstractQueryBuilder<B>>

  • Type Parameters:
    B - the builder
    Direct Known Subclasses:
    QueryBuilder, QueryTagBuilder
    public abstract class AbstractQueryBuilder<B extends AbstractQueryBuilder<B>>
extends Object
    Abstract class for querying KairosDB.

    • Method Detail

      • buildGson

        protected abstract com.google.gson.Gson buildGson()
        Builds Gson used by this implementation

      • getStartAbsolute

        public Date getStartAbsolute()
        Returns the absolute range start time.
        Returns:
        absolute range start time

      • getEndAbsolute

        public Date getEndAbsolute()
        Returns the absolute range end time.
        Returns:
        absolute range end time

      • getStartRelative

        public RelativeTime getStartRelative()
        Returns the relative range start time.
        Returns:
        relative range start time

      • getEndRelative

        public RelativeTime getEndRelative()
        Returns the relative range end time.
        Returns:
        relative range end time

      • setStart

        public B setStart​(Date start)
        The beginning time of the time range.
        Parameters:
        start - start time
        Returns:
        the builder

      • setStart

        public B setStart​(int duration,
                  TimeUnit unit)
        The beginning time of the time range relative to now. For example, return all data points that starting 2 days ago.
        Parameters:
        duration - relative time value
        unit - unit of time
        Returns:
        the builder

      • setEnd

        public B setEnd​(Date end)
        The ending value of the time range. Must be later in time than the start time. An end time is not required and default to now.
        Parameters:
        end - end time
        Returns:
        the builder

      • setEnd

        public B setEnd​(int duration,
                TimeUnit unit)
        The ending time of the time range relative to now.
        Parameters:
        duration - relative time value
        unit - unit of time
        Returns:
        the builder

      • build

        public String build()
        Returns the JSON string built by the builder. This is the JSON that can be used by the client to query KairosDB
        Returns:
        JSON

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object