com.google.monitoring.v3

Enum Aggregation.Aligner

java.lang.Object

java.lang.Enum<Aggregation.Aligner>

com.google.monitoring.v3.Aggregation.Aligner

All Implemented Interfaces:

Internal.EnumLite, ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<Aggregation.Aligner>

Enclosing class:

Aggregation

public static enum Aggregation.Aligner
extends java.lang.Enum<Aggregation.Aligner>
implements ProtocolMessageEnum

 The Aligner describes how to bring the data points in a single
 time series into temporal alignment.
 

Protobuf enum google.monitoring.v3.Aggregation.Aligner

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALIGN_COUNT Align time series via aggregation.
ALIGN_COUNT_FALSE Align time series via aggregation.
ALIGN_COUNT_TRUE Align time series via aggregation.
ALIGN_DELTA Align and convert to delta metric type.
ALIGN_FRACTION_TRUE Align time series via aggregation.
ALIGN_INTERPOLATE Align by interpolating between adjacent points around the period boundary.
ALIGN_MAX Align time series via aggregation.
ALIGN_MEAN Align time series via aggregation.
ALIGN_MIN Align time series via aggregation.
ALIGN_NEXT_OLDER Align by shifting the oldest data point before the period boundary to the boundary.
ALIGN_NONE No alignment.
ALIGN_PERCENT_CHANGE Align and convert to a percentage change.
ALIGN_PERCENTILE_05 Align time series via aggregation.
ALIGN_PERCENTILE_50 Align time series via aggregation.
ALIGN_PERCENTILE_95 Align time series via aggregation.
ALIGN_PERCENTILE_99 Align time series via aggregation.
ALIGN_RATE Align and convert to a rate.
ALIGN_STDDEV Align time series via aggregation.
ALIGN_SUM Align time series via aggregation.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_COUNT_FALSE_VALUE Align time series via aggregation.
static int	ALIGN_COUNT_TRUE_VALUE Align time series via aggregation.
static int	ALIGN_COUNT_VALUE Align time series via aggregation.
static int	ALIGN_DELTA_VALUE Align and convert to delta metric type.
static int	ALIGN_FRACTION_TRUE_VALUE Align time series via aggregation.
static int	ALIGN_INTERPOLATE_VALUE Align by interpolating between adjacent points around the period boundary.
static int	ALIGN_MAX_VALUE Align time series via aggregation.
static int	ALIGN_MEAN_VALUE Align time series via aggregation.
static int	ALIGN_MIN_VALUE Align time series via aggregation.
static int	ALIGN_NEXT_OLDER_VALUE Align by shifting the oldest data point before the period boundary to the boundary.
static int	ALIGN_NONE_VALUE No alignment.
static int	ALIGN_PERCENT_CHANGE_VALUE Align and convert to a percentage change.
static int	ALIGN_PERCENTILE_05_VALUE Align time series via aggregation.
static int	ALIGN_PERCENTILE_50_VALUE Align time series via aggregation.
static int	ALIGN_PERCENTILE_95_VALUE Align time series via aggregation.
static int	ALIGN_PERCENTILE_99_VALUE Align time series via aggregation.
static int	ALIGN_RATE_VALUE Align and convert to a rate.
static int	ALIGN_STDDEV_VALUE Align time series via aggregation.
static int	ALIGN_SUM_VALUE Align time series via aggregation.

Method Summary

Modifier and Type	Method and Description
static Aggregation.Aligner	forNumber(int value)
static Descriptors.EnumDescriptor	getDescriptor()
Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
Descriptors.EnumValueDescriptor	getValueDescriptor()
static Internal.EnumLiteMap<Aggregation.Aligner>	internalGetValueMap()
static Aggregation.Aligner	valueOf(Descriptors.EnumValueDescriptor desc)
static Aggregation.Aligner	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Aggregation.Aligner	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Aggregation.Aligner[]	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

ALIGN_NONE

public static final Aggregation.Aligner ALIGN_NONE

 No alignment. Raw data is returned. Not valid if cross-time
 series reduction is requested. The value type of the result is
 the same as the value type of the input.
 

ALIGN_NONE = 0;

ALIGN_DELTA

public static final Aggregation.Aligner ALIGN_DELTA

 Align and convert to delta metric type. This alignment is valid
 for cumulative metrics and delta metrics. Aligning an existing
 delta metric to a delta metric requires that the alignment
 period be increased. The value type of the result is the same
 as the value type of the input.
 One can think of this aligner as a rate but without time units; that
 is, the output is conceptually (second_point - first_point).
 

ALIGN_DELTA = 1;

ALIGN_RATE

public static final Aggregation.Aligner ALIGN_RATE

 Align and convert to a rate. This alignment is valid for
 cumulative metrics and delta metrics with numeric values. The output is a
 gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 One can think of this aligner as conceptually providing the slope of
 the line that passes through the value at the start and end of the
 window. In other words, this is conceptually ((y1 - y0)/(t1 - t0)),
 and the output unit is one that has a "/time" dimension.
 If, by rate, you are looking for percentage change, see the
 `ALIGN_PERCENT_CHANGE` aligner option.
 

ALIGN_RATE = 2;

ALIGN_INTERPOLATE

public static final Aggregation.Aligner ALIGN_INTERPOLATE

 Align by interpolating between adjacent points around the
 period boundary. This alignment is valid for gauge
 metrics with numeric values. The value type of the result is the same
 as the value type of the input.
 

ALIGN_INTERPOLATE = 3;

ALIGN_NEXT_OLDER

public static final Aggregation.Aligner ALIGN_NEXT_OLDER

 Align by shifting the oldest data point before the period
 boundary to the boundary. This alignment is valid for gauge
 metrics. The value type of the result is the same as the
 value type of the input.
 

ALIGN_NEXT_OLDER = 4;

ALIGN_MIN

public static final Aggregation.Aligner ALIGN_MIN

 Align time series via aggregation. The resulting data point in
 the alignment period is the minimum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 values. The value type of the result is the same as the value
 type of the input.
 

ALIGN_MIN = 10;

ALIGN_MAX

public static final Aggregation.Aligner ALIGN_MAX

 Align time series via aggregation. The resulting data point in
 the alignment period is the maximum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 values. The value type of the result is the same as the value
 type of the input.
 

ALIGN_MAX = 11;

ALIGN_MEAN

public static final Aggregation.Aligner ALIGN_MEAN

 Align time series via aggregation. The resulting data point in
 the alignment period is the average or arithmetic mean of all
 data points in the period. This alignment is valid for gauge and delta
 metrics with numeric values. The value type of the output is
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_MEAN = 12;

ALIGN_COUNT

public static final Aggregation.Aligner ALIGN_COUNT

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 or Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT = 13;

ALIGN_SUM

public static final Aggregation.Aligner ALIGN_SUM

 Align time series via aggregation. The resulting data point in
 the alignment period is the sum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 and distribution values. The value type of the output is the
 same as the value type of the input.
 

ALIGN_SUM = 14;

ALIGN_STDDEV

public static final Aggregation.Aligner ALIGN_STDDEV

 Align time series via aggregation. The resulting data point in
 the alignment period is the standard deviation of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with numeric values. The value type of the output is
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_STDDEV = 15;

ALIGN_COUNT_TRUE

public static final Aggregation.Aligner ALIGN_COUNT_TRUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of True-valued data points in the
 period. This alignment is valid for gauge metrics with
 Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT_TRUE = 16;

ALIGN_COUNT_FALSE

public static final Aggregation.Aligner ALIGN_COUNT_FALSE

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of False-valued data points in the
 period. This alignment is valid for gauge metrics with
 Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT_FALSE = 24;

ALIGN_FRACTION_TRUE

public static final Aggregation.Aligner ALIGN_FRACTION_TRUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the fraction of True-valued data points in the
 period. This alignment is valid for gauge metrics with Boolean values.
 The output value is in the range [0, 1] and has value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_FRACTION_TRUE = 17;

ALIGN_PERCENTILE_99

public static final Aggregation.Aligner ALIGN_PERCENTILE_99

 Align time series via aggregation. The resulting data point in
 the alignment period is the 99th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_99 = 18;

ALIGN_PERCENTILE_95

public static final Aggregation.Aligner ALIGN_PERCENTILE_95

 Align time series via aggregation. The resulting data point in
 the alignment period is the 95th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_95 = 19;

ALIGN_PERCENTILE_50

public static final Aggregation.Aligner ALIGN_PERCENTILE_50

 Align time series via aggregation. The resulting data point in
 the alignment period is the 50th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_50 = 20;

ALIGN_PERCENTILE_05

public static final Aggregation.Aligner ALIGN_PERCENTILE_05

 Align time series via aggregation. The resulting data point in
 the alignment period is the 5th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_05 = 21;

ALIGN_PERCENT_CHANGE

public static final Aggregation.Aligner ALIGN_PERCENT_CHANGE

 Align and convert to a percentage change. This alignment is valid for
 gauge and delta metrics with numeric values. This alignment conceptually
 computes the equivalent of "((current - previous)/previous)*100"
 where previous value is determined based on the alignmentPeriod.
 In the event that previous is 0 the calculated value is infinity with the
 exception that if both (current - previous) and previous are 0 the
 calculated value is 0.
 A 10 minute moving mean is computed at each point of the time window
 prior to the above calculation to smooth the metric and prevent false
 positives from very short lived spikes.
 Only applicable for data that is >= 0. Any values < 0 are treated as
 no data. While delta metrics are accepted by this alignment special care
 should be taken that the values for the metric will always be positive.
 The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENT_CHANGE = 23;

UNRECOGNIZED

public static final Aggregation.Aligner UNRECOGNIZED

Field Detail

ALIGN_NONE_VALUE

public static final int ALIGN_NONE_VALUE

 No alignment. Raw data is returned. Not valid if cross-time
 series reduction is requested. The value type of the result is
 the same as the value type of the input.
 

ALIGN_NONE = 0;

See Also:

Constant Field Values

ALIGN_DELTA_VALUE

public static final int ALIGN_DELTA_VALUE

 Align and convert to delta metric type. This alignment is valid
 for cumulative metrics and delta metrics. Aligning an existing
 delta metric to a delta metric requires that the alignment
 period be increased. The value type of the result is the same
 as the value type of the input.
 One can think of this aligner as a rate but without time units; that
 is, the output is conceptually (second_point - first_point).
 

ALIGN_DELTA = 1;

See Also:

Constant Field Values

ALIGN_RATE_VALUE

public static final int ALIGN_RATE_VALUE

 Align and convert to a rate. This alignment is valid for
 cumulative metrics and delta metrics with numeric values. The output is a
 gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 One can think of this aligner as conceptually providing the slope of
 the line that passes through the value at the start and end of the
 window. In other words, this is conceptually ((y1 - y0)/(t1 - t0)),
 and the output unit is one that has a "/time" dimension.
 If, by rate, you are looking for percentage change, see the
 `ALIGN_PERCENT_CHANGE` aligner option.
 

ALIGN_RATE = 2;

See Also:

Constant Field Values

ALIGN_INTERPOLATE_VALUE

public static final int ALIGN_INTERPOLATE_VALUE

 Align by interpolating between adjacent points around the
 period boundary. This alignment is valid for gauge
 metrics with numeric values. The value type of the result is the same
 as the value type of the input.
 

ALIGN_INTERPOLATE = 3;

See Also:

Constant Field Values

ALIGN_NEXT_OLDER_VALUE

public static final int ALIGN_NEXT_OLDER_VALUE

 Align by shifting the oldest data point before the period
 boundary to the boundary. This alignment is valid for gauge
 metrics. The value type of the result is the same as the
 value type of the input.
 

ALIGN_NEXT_OLDER = 4;

See Also:

Constant Field Values

ALIGN_MIN_VALUE

public static final int ALIGN_MIN_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the minimum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 values. The value type of the result is the same as the value
 type of the input.
 

ALIGN_MIN = 10;

See Also:

Constant Field Values

ALIGN_MAX_VALUE

public static final int ALIGN_MAX_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the maximum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 values. The value type of the result is the same as the value
 type of the input.
 

ALIGN_MAX = 11;

See Also:

Constant Field Values

ALIGN_MEAN_VALUE

public static final int ALIGN_MEAN_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the average or arithmetic mean of all
 data points in the period. This alignment is valid for gauge and delta
 metrics with numeric values. The value type of the output is
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_MEAN = 12;

See Also:

Constant Field Values

ALIGN_COUNT_VALUE

public static final int ALIGN_COUNT_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 or Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT = 13;

See Also:

Constant Field Values

ALIGN_SUM_VALUE

public static final int ALIGN_SUM_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the sum of all data points in the
 period. This alignment is valid for gauge and delta metrics with numeric
 and distribution values. The value type of the output is the
 same as the value type of the input.
 

ALIGN_SUM = 14;

See Also:

Constant Field Values

ALIGN_STDDEV_VALUE

public static final int ALIGN_STDDEV_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the standard deviation of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with numeric values. The value type of the output is
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_STDDEV = 15;

See Also:

Constant Field Values

ALIGN_COUNT_TRUE_VALUE

public static final int ALIGN_COUNT_TRUE_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of True-valued data points in the
 period. This alignment is valid for gauge metrics with
 Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT_TRUE = 16;

See Also:

Constant Field Values

ALIGN_COUNT_FALSE_VALUE

public static final int ALIGN_COUNT_FALSE_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the count of False-valued data points in the
 period. This alignment is valid for gauge metrics with
 Boolean values. The value type of the output is
 [INT64][google.api.MetricDescriptor.ValueType.INT64].
 

ALIGN_COUNT_FALSE = 24;

See Also:

Constant Field Values

ALIGN_FRACTION_TRUE_VALUE

public static final int ALIGN_FRACTION_TRUE_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the fraction of True-valued data points in the
 period. This alignment is valid for gauge metrics with Boolean values.
 The output value is in the range [0, 1] and has value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_FRACTION_TRUE = 17;

See Also:

Constant Field Values

ALIGN_PERCENTILE_99_VALUE

public static final int ALIGN_PERCENTILE_99_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the 99th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_99 = 18;

See Also:

Constant Field Values

ALIGN_PERCENTILE_95_VALUE

public static final int ALIGN_PERCENTILE_95_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the 95th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_95 = 19;

See Also:

Constant Field Values

ALIGN_PERCENTILE_50_VALUE

public static final int ALIGN_PERCENTILE_50_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the 50th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_50 = 20;

See Also:

Constant Field Values

ALIGN_PERCENTILE_05_VALUE

public static final int ALIGN_PERCENTILE_05_VALUE

 Align time series via aggregation. The resulting data point in
 the alignment period is the 5th percentile of all data
 points in the period. This alignment is valid for gauge and delta metrics
 with distribution values. The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENTILE_05 = 21;

See Also:

Constant Field Values

ALIGN_PERCENT_CHANGE_VALUE

public static final int ALIGN_PERCENT_CHANGE_VALUE

 Align and convert to a percentage change. This alignment is valid for
 gauge and delta metrics with numeric values. This alignment conceptually
 computes the equivalent of "((current - previous)/previous)*100"
 where previous value is determined based on the alignmentPeriod.
 In the event that previous is 0 the calculated value is infinity with the
 exception that if both (current - previous) and previous are 0 the
 calculated value is 0.
 A 10 minute moving mean is computed at each point of the time window
 prior to the above calculation to smooth the metric and prevent false
 positives from very short lived spikes.
 Only applicable for data that is >= 0. Any values < 0 are treated as
 no data. While delta metrics are accepted by this alignment special care
 should be taken that the values for the metric will always be positive.
 The output is a gauge metric with value type
 [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
 

ALIGN_PERCENT_CHANGE = 23;

See Also:

Constant Field Values

Method Detail

values

public static Aggregation.Aligner[] 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 (Aggregation.Aligner c : Aggregation.Aligner.values())
    System.out.println(c);

Returns:

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

valueOf

public static Aggregation.Aligner valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface Internal.EnumLite

Specified by:

getNumber in interface ProtocolMessageEnum

valueOf

@Deprecated
public static Aggregation.Aligner valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static Aggregation.Aligner forNumber(int value)

internalGetValueMap

public static Internal.EnumLiteMap<Aggregation.Aligner> internalGetValueMap()

getValueDescriptor

public final Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface ProtocolMessageEnum

getDescriptorForType

public final Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface ProtocolMessageEnum

getDescriptor

public static final Descriptors.EnumDescriptor getDescriptor()

valueOf

public static Aggregation.Aligner valueOf(Descriptors.EnumValueDescriptor desc)