io.cdap.cdap.api.dataset.lib.cube

Enum AggregationOption

java.lang.Object

java.lang.Enum<AggregationOption>

io.cdap.cdap.api.dataset.lib.cube.AggregationOption

All Implemented Interfaces:

Serializable, Comparable<AggregationOption>

public enum AggregationOption
extends Enum<AggregationOption>

The metrics aggregation option. It provides multiple options to aggregate the metrics: TRUE: if the aggregation is set to TRUE, the metrics query will always use the total resolution table for result, which means the start and end time are ignored, and the number of data point for any metric name and tags will be 1. FALSE: if the aggregation is set to FALSE, the metrics query will not do any aggregation on the data points. The resolution will be determined based on the start and end time, the number of data points returned will be based on the count specified in the query. If the number of data points > count, the latest data points will be returned. Else, all the data points will be returned. If no count is specified, all the data points will be returned. SUM: if the aggregation is set to SUM, the metrics query will partition the number of metrics data points to the given count. Each partition will get aggregated to the sum of the interval. Depending on whether there is a remainder R, the first R data points will be discarded. If no count is specified or count is greater than or equal to the number of data points, all the data points will be returned. For example, if the metrics query result has 100 data points, and if the count is 10, then each 10 of the data points will be aggregated to one single point based on the aggregation option. If there are 100 points and the count is 8, since remainder is 4, first 4 data points will be discarded. The buckets will have 100 / 8 = 12 data points aggregated, with 96 data points in total. LATEST: if the aggregation is set to LATEST, the metrics query will behave similar to SUM. The only difference is that the data points in the partitioned interval will get aggregated to the last data point.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FALSE
LATEST
SUM
TRUE

Method Summary

Modifier and Type	Method and Description
static AggregationOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static AggregationOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRUE

public static final AggregationOption TRUE

FALSE

public static final AggregationOption FALSE

SUM

public static final AggregationOption SUM

LATEST

public static final AggregationOption LATEST

Method Detail

values

public static AggregationOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AggregationOption c : AggregationOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AggregationOption valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null