public static enum Aggregation.Aligner extends Enum<Aggregation.Aligner> implements com.google.protobuf.ProtocolMessageEnum
The `Aligner` specifies the operation that will be applied to the data points in each alignment period in a time series. Except for `ALIGN_NONE`, which specifies that no operation be applied, each alignment operation replaces the set of data values in each alignment period with a single value: the result of applying the operation to the data values. An aligned time series has a single data value at the end of each `alignment_period`. An alignment operation can change the data type of the values, too. For example, if you apply a counting operation to boolean values, the data `value_type` in the original time series is `BOOLEAN`, but the `value_type` in the aligned result is `INT64`.Protobuf enum
google.monitoring.v3.Aggregation.Aligner| Enum Constant and Description |
|---|
ALIGN_COUNT
Align the time series by returning the number of values in each alignment
period.
|
ALIGN_COUNT_FALSE
Align the time series by returning the number of `False` values in
each alignment period.
|
ALIGN_COUNT_TRUE
Align the time series by returning the number of `True` values in
each alignment period.
|
ALIGN_DELTA
Align and convert to
[DELTA][google.api.MetricDescriptor.MetricKind.DELTA].
|
ALIGN_FRACTION_TRUE
Align the time series by returning the ratio of the number of `True`
values to the total number of values in each alignment period.
|
ALIGN_INTERPOLATE
Align by interpolating between adjacent points around the alignment
period boundary.
|
ALIGN_MAX
Align the time series by returning the maximum value in each alignment
period.
|
ALIGN_MEAN
Align the time series by returning the mean value in each alignment
period.
|
ALIGN_MIN
Align the time series by returning the minimum value in each alignment
period.
|
ALIGN_NEXT_OLDER
Align by moving the most recent data point before the end of the
alignment period to the boundary at the end of the alignment
period.
|
ALIGN_NONE
No alignment.
|
ALIGN_PERCENT_CHANGE
Align and convert to a percentage change.
|
ALIGN_PERCENTILE_05
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
ALIGN_PERCENTILE_50
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
ALIGN_PERCENTILE_95
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
ALIGN_PERCENTILE_99
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
ALIGN_RATE
Align and convert to a rate.
|
ALIGN_STDDEV
Align the time series by returning the standard deviation of the values
in each alignment period.
|
ALIGN_SUM
Align the time series by returning the sum of the values in each
alignment period.
|
UNRECOGNIZED |
| Modifier and Type | Field and Description |
|---|---|
static int |
ALIGN_COUNT_FALSE_VALUE
Align the time series by returning the number of `False` values in
each alignment period.
|
static int |
ALIGN_COUNT_TRUE_VALUE
Align the time series by returning the number of `True` values in
each alignment period.
|
static int |
ALIGN_COUNT_VALUE
Align the time series by returning the number of values in each alignment
period.
|
static int |
ALIGN_DELTA_VALUE
Align and convert to
[DELTA][google.api.MetricDescriptor.MetricKind.DELTA].
|
static int |
ALIGN_FRACTION_TRUE_VALUE
Align the time series by returning the ratio of the number of `True`
values to the total number of values in each alignment period.
|
static int |
ALIGN_INTERPOLATE_VALUE
Align by interpolating between adjacent points around the alignment
period boundary.
|
static int |
ALIGN_MAX_VALUE
Align the time series by returning the maximum value in each alignment
period.
|
static int |
ALIGN_MEAN_VALUE
Align the time series by returning the mean value in each alignment
period.
|
static int |
ALIGN_MIN_VALUE
Align the time series by returning the minimum value in each alignment
period.
|
static int |
ALIGN_NEXT_OLDER_VALUE
Align by moving the most recent data point before the end of the
alignment period to the boundary at the end of the alignment
period.
|
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 the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
static int |
ALIGN_PERCENTILE_50_VALUE
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
static int |
ALIGN_PERCENTILE_95_VALUE
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
static int |
ALIGN_PERCENTILE_99_VALUE
Align the time series by using [percentile
aggregation](https://en.wikipedia.org/wiki/Percentile).
|
static int |
ALIGN_RATE_VALUE
Align and convert to a rate.
|
static int |
ALIGN_STDDEV_VALUE
Align the time series by returning the standard deviation of the values
in each alignment period.
|
static int |
ALIGN_SUM_VALUE
Align the time series by returning the sum of the values in each
alignment period.
|
| Modifier and Type | Method and Description |
|---|---|
static Aggregation.Aligner |
forNumber(int value) |
static com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptor() |
com.google.protobuf.Descriptors.EnumDescriptor |
getDescriptorForType() |
int |
getNumber() |
com.google.protobuf.Descriptors.EnumValueDescriptor |
getValueDescriptor() |
static com.google.protobuf.Internal.EnumLiteMap<Aggregation.Aligner> |
internalGetValueMap() |
static Aggregation.Aligner |
valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) |
static Aggregation.Aligner |
valueOf(int value)
Deprecated.
Use
forNumber(int) instead. |
static Aggregation.Aligner |
valueOf(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.
|
public static final Aggregation.Aligner ALIGN_NONE
No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The `value_type` of the result is the same as the `value_type` of the input.
ALIGN_NONE = 0;public static final Aggregation.Aligner ALIGN_DELTA
Align and convert to [DELTA][google.api.MetricDescriptor.MetricKind.DELTA]. The output is `delta = y1 - y0`. This alignment is valid for [CUMULATIVE][google.api.MetricDescriptor.MetricKind.CUMULATIVE] and `DELTA` metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_DELTA = 1;public static final Aggregation.Aligner ALIGN_RATE
Align and convert to a rate. The result is computed as `rate = (y1 - y0)/(t1 - t0)`, or "delta over time". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the `alignment_period`. This aligner is valid for `CUMULATIVE` and `DELTA` metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a `GAUGE` metric with `value_type` `DOUBLE`. If, by "rate", you mean "percentage change", see the `ALIGN_PERCENT_CHANGE` aligner instead.
ALIGN_RATE = 2;public static final Aggregation.Aligner ALIGN_INTERPOLATE
Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for `GAUGE` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_INTERPOLATE = 3;public static final Aggregation.Aligner ALIGN_NEXT_OLDER
Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for `GAUGE` metrics. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_NEXT_OLDER = 4;public static final Aggregation.Aligner ALIGN_MIN
Align the time series by returning the minimum value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_MIN = 10;public static final Aggregation.Aligner ALIGN_MAX
Align the time series by returning the maximum value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_MAX = 11;public static final Aggregation.Aligner ALIGN_MEAN
Align the time series by returning the mean value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is `DOUBLE`.
ALIGN_MEAN = 12;public static final Aggregation.Aligner ALIGN_COUNT
Align the time series by returning the number of values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric or Boolean values. The `value_type` of the aligned result is `INT64`.
ALIGN_COUNT = 13;public static final Aggregation.Aligner ALIGN_SUM
Align the time series by returning the sum of the values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric and distribution values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_SUM = 14;public static final Aggregation.Aligner ALIGN_STDDEV
Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the output is `DOUBLE`.
ALIGN_STDDEV = 15;public static final Aggregation.Aligner ALIGN_COUNT_TRUE
Align the time series by returning the number of `True` values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The `value_type` of the output is `INT64`.
ALIGN_COUNT_TRUE = 16;public static final Aggregation.Aligner ALIGN_COUNT_FALSE
Align the time series by returning the number of `False` values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The `value_type` of the output is `INT64`.
ALIGN_COUNT_FALSE = 24;public static final Aggregation.Aligner ALIGN_FRACTION_TRUE
Align the time series by returning the ratio of the number of `True` values to the total number of values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The output value is in the range [0.0, 1.0] and has `value_type` `DOUBLE`.
ALIGN_FRACTION_TRUE = 17;public static final Aggregation.Aligner ALIGN_PERCENTILE_99
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_99 = 18;public static final Aggregation.Aligner ALIGN_PERCENTILE_95
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_95 = 19;public static final Aggregation.Aligner ALIGN_PERCENTILE_50
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_50 = 20;public static final Aggregation.Aligner ALIGN_PERCENTILE_05
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_05 = 21;public static final Aggregation.Aligner ALIGN_PERCENT_CHANGE
Align and convert to a percentage change. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. This alignment returns `((current - previous)/previous) * 100`, where the value of `previous` is determined based on the `alignment_period`. If the values of `current` and `previous` are both 0, then the returned value is 0. If only `previous` is 0, the returned value is infinity. A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are `>= 0`. Any values `< 0` are treated as a missing datapoint, and are ignored. 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`.
ALIGN_PERCENT_CHANGE = 23;public static final Aggregation.Aligner UNRECOGNIZED
public static final int ALIGN_NONE_VALUE
No alignment. Raw data is returned. Not valid if cross-series reduction is requested. The `value_type` of the result is the same as the `value_type` of the input.
ALIGN_NONE = 0;public static final int ALIGN_DELTA_VALUE
Align and convert to [DELTA][google.api.MetricDescriptor.MetricKind.DELTA]. The output is `delta = y1 - y0`. This alignment is valid for [CUMULATIVE][google.api.MetricDescriptor.MetricKind.CUMULATIVE] and `DELTA` metrics. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_DELTA = 1;public static final int ALIGN_RATE_VALUE
Align and convert to a rate. The result is computed as `rate = (y1 - y0)/(t1 - t0)`, or "delta over time". Think of this aligner as providing the slope of the line that passes through the value at the start and at the end of the `alignment_period`. This aligner is valid for `CUMULATIVE` and `DELTA` metrics with numeric values. If the selected alignment period results in periods with no data, then the aligned value for such a period is created by interpolation. The output is a `GAUGE` metric with `value_type` `DOUBLE`. If, by "rate", you mean "percentage change", see the `ALIGN_PERCENT_CHANGE` aligner instead.
ALIGN_RATE = 2;public static final int ALIGN_INTERPOLATE_VALUE
Align by interpolating between adjacent points around the alignment period boundary. This aligner is valid for `GAUGE` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_INTERPOLATE = 3;public static final int ALIGN_NEXT_OLDER_VALUE
Align by moving the most recent data point before the end of the alignment period to the boundary at the end of the alignment period. This aligner is valid for `GAUGE` metrics. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_NEXT_OLDER = 4;public static final int ALIGN_MIN_VALUE
Align the time series by returning the minimum value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_MIN = 10;public static final int ALIGN_MAX_VALUE
Align the time series by returning the maximum value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_MAX = 11;public static final int ALIGN_MEAN_VALUE
Align the time series by returning the mean value in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the aligned result is `DOUBLE`.
ALIGN_MEAN = 12;public static final int ALIGN_COUNT_VALUE
Align the time series by returning the number of values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric or Boolean values. The `value_type` of the aligned result is `INT64`.
ALIGN_COUNT = 13;public static final int ALIGN_SUM_VALUE
Align the time series by returning the sum of the values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric and distribution values. The `value_type` of the aligned result is the same as the `value_type` of the input.
ALIGN_SUM = 14;public static final int ALIGN_STDDEV_VALUE
Align the time series by returning the standard deviation of the values in each alignment period. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. The `value_type` of the output is `DOUBLE`.
ALIGN_STDDEV = 15;public static final int ALIGN_COUNT_TRUE_VALUE
Align the time series by returning the number of `True` values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The `value_type` of the output is `INT64`.
ALIGN_COUNT_TRUE = 16;public static final int ALIGN_COUNT_FALSE_VALUE
Align the time series by returning the number of `False` values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The `value_type` of the output is `INT64`.
ALIGN_COUNT_FALSE = 24;public static final int ALIGN_FRACTION_TRUE_VALUE
Align the time series by returning the ratio of the number of `True` values to the total number of values in each alignment period. This aligner is valid for `GAUGE` metrics with Boolean values. The output value is in the range [0.0, 1.0] and has `value_type` `DOUBLE`.
ALIGN_FRACTION_TRUE = 17;public static final int ALIGN_PERCENTILE_99_VALUE
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 99th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_99 = 18;public static final int ALIGN_PERCENTILE_95_VALUE
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 95th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_95 = 19;public static final int ALIGN_PERCENTILE_50_VALUE
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 50th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_50 = 20;public static final int ALIGN_PERCENTILE_05_VALUE
Align the time series by using [percentile aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting data point in each alignment period is the 5th percentile of all data points in the period. This aligner is valid for `GAUGE` and `DELTA` metrics with distribution values. The output is a `GAUGE` metric with `value_type` `DOUBLE`.
ALIGN_PERCENTILE_05 = 21;public static final int ALIGN_PERCENT_CHANGE_VALUE
Align and convert to a percentage change. This aligner is valid for `GAUGE` and `DELTA` metrics with numeric values. This alignment returns `((current - previous)/previous) * 100`, where the value of `previous` is determined based on the `alignment_period`. If the values of `current` and `previous` are both 0, then the returned value is 0. If only `previous` is 0, the returned value is infinity. A 10-minute moving mean is computed at each point of the alignment period prior to the above calculation to smooth the metric and prevent false positives from very short-lived spikes. The moving mean is only applicable for data whose values are `>= 0`. Any values `< 0` are treated as a missing datapoint, and are ignored. 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`.
ALIGN_PERCENT_CHANGE = 23;public static Aggregation.Aligner[] values()
for (Aggregation.Aligner c : Aggregation.Aligner.values()) System.out.println(c);
public static Aggregation.Aligner valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic final int getNumber()
getNumber in interface com.google.protobuf.Internal.EnumLitegetNumber in interface com.google.protobuf.ProtocolMessageEnum@Deprecated public static Aggregation.Aligner valueOf(int value)
forNumber(int) instead.value - The numeric wire value of the corresponding enum entry.public static Aggregation.Aligner forNumber(int value)
value - The numeric wire value of the corresponding enum entry.public static com.google.protobuf.Internal.EnumLiteMap<Aggregation.Aligner> internalGetValueMap()
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnumpublic final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnumpublic static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
public static Aggregation.Aligner valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
Copyright © 2024 Google LLC. All rights reserved.