- 2.49.0 (latest)
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.0
- 2.3.0
- 2.2.6
public interface AggregationOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getAlignmentPeriod()
public abstract Duration getAlignmentPeriod()
The alignment_period
specifies a time interval, in seconds, that is used
to divide the data in all the
time series into consistent blocks of
time. This will be done before the per-series aligner can be applied to
the data.
The value must be at least 60 seconds. If a per-series aligner other than
ALIGN_NONE
is specified, this field is required or an error is returned.
If no per-series aligner is specified, or the aligner ALIGN_NONE
is
specified, then this field is ignored.
The maximum value of the alignment_period
is 2 years, or 104 weeks.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
Duration | The alignmentPeriod. |
getAlignmentPeriodOrBuilder()
public abstract DurationOrBuilder getAlignmentPeriodOrBuilder()
The alignment_period
specifies a time interval, in seconds, that is used
to divide the data in all the
time series into consistent blocks of
time. This will be done before the per-series aligner can be applied to
the data.
The value must be at least 60 seconds. If a per-series aligner other than
ALIGN_NONE
is specified, this field is required or an error is returned.
If no per-series aligner is specified, or the aligner ALIGN_NONE
is
specified, then this field is ignored.
The maximum value of the alignment_period
is 2 years, or 104 weeks.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getCrossSeriesReducer()
public abstract Aggregation.Reducer getCrossSeriesReducer()
The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.
Not all reducer operations can be applied to all time series. The valid
choices depend on the metric_kind
and the value_type
of the original
time series. Reduction can yield a time series with a different
metric_kind
or value_type
than the input time series.
Time series data must first be aligned (see per_series_aligner
) in order
to perform cross-time series reduction. If cross_series_reducer
is
specified, then per_series_aligner
must be specified, and must not be
ALIGN_NONE
. An alignment_period
must also be specified; otherwise, an
error is returned.
.google.monitoring.dashboard.v1.Aggregation.Reducer cross_series_reducer = 4;
Returns | |
---|---|
Type | Description |
Aggregation.Reducer | The crossSeriesReducer. |
getCrossSeriesReducerValue()
public abstract int getCrossSeriesReducerValue()
The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.
Not all reducer operations can be applied to all time series. The valid
choices depend on the metric_kind
and the value_type
of the original
time series. Reduction can yield a time series with a different
metric_kind
or value_type
than the input time series.
Time series data must first be aligned (see per_series_aligner
) in order
to perform cross-time series reduction. If cross_series_reducer
is
specified, then per_series_aligner
must be specified, and must not be
ALIGN_NONE
. An alignment_period
must also be specified; otherwise, an
error is returned.
.google.monitoring.dashboard.v1.Aggregation.Reducer cross_series_reducer = 4;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for crossSeriesReducer. |
getGroupByFields(int index)
public abstract String getGroupByFields(int index)
The set of fields to preserve when cross_series_reducer
is
specified. The group_by_fields
determine how the time series are
partitioned into subsets prior to applying the aggregation
operation. Each subset contains time series that have the same
value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The
cross_series_reducer
is applied to each subset of time series.
It is not possible to reduce across different resource types, so
this field implicitly contains resource.type
. Fields not
specified in group_by_fields
are aggregated away. If
group_by_fields
is not specified and all the time series have
the same resource type, then the time series are aggregated into
a single output time series. If cross_series_reducer
is not
defined, this field is ignored.
repeated string group_by_fields = 5;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The groupByFields at the given index. |
getGroupByFieldsBytes(int index)
public abstract ByteString getGroupByFieldsBytes(int index)
The set of fields to preserve when cross_series_reducer
is
specified. The group_by_fields
determine how the time series are
partitioned into subsets prior to applying the aggregation
operation. Each subset contains time series that have the same
value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The
cross_series_reducer
is applied to each subset of time series.
It is not possible to reduce across different resource types, so
this field implicitly contains resource.type
. Fields not
specified in group_by_fields
are aggregated away. If
group_by_fields
is not specified and all the time series have
the same resource type, then the time series are aggregated into
a single output time series. If cross_series_reducer
is not
defined, this field is ignored.
repeated string group_by_fields = 5;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the groupByFields at the given index. |
getGroupByFieldsCount()
public abstract int getGroupByFieldsCount()
The set of fields to preserve when cross_series_reducer
is
specified. The group_by_fields
determine how the time series are
partitioned into subsets prior to applying the aggregation
operation. Each subset contains time series that have the same
value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The
cross_series_reducer
is applied to each subset of time series.
It is not possible to reduce across different resource types, so
this field implicitly contains resource.type
. Fields not
specified in group_by_fields
are aggregated away. If
group_by_fields
is not specified and all the time series have
the same resource type, then the time series are aggregated into
a single output time series. If cross_series_reducer
is not
defined, this field is ignored.
repeated string group_by_fields = 5;
Returns | |
---|---|
Type | Description |
int | The count of groupByFields. |
getGroupByFieldsList()
public abstract List<String> getGroupByFieldsList()
The set of fields to preserve when cross_series_reducer
is
specified. The group_by_fields
determine how the time series are
partitioned into subsets prior to applying the aggregation
operation. Each subset contains time series that have the same
value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The
cross_series_reducer
is applied to each subset of time series.
It is not possible to reduce across different resource types, so
this field implicitly contains resource.type
. Fields not
specified in group_by_fields
are aggregated away. If
group_by_fields
is not specified and all the time series have
the same resource type, then the time series are aggregated into
a single output time series. If cross_series_reducer
is not
defined, this field is ignored.
repeated string group_by_fields = 5;
Returns | |
---|---|
Type | Description |
List<String> | A list containing the groupByFields. |
getPerSeriesAligner()
public abstract Aggregation.Aligner getPerSeriesAligner()
An Aligner
describes how to bring the data points in a single
time series into temporal alignment. Except for ALIGN_NONE
, all
alignments cause all the data points in an alignment_period
to be
mathematically grouped together, resulting in a single data point for
each alignment_period
with end timestamp at the end of the period.
Not all alignment operations may be applied to all time series. The valid
choices depend on the metric_kind
and value_type
of the original time
series. Alignment can change the metric_kind
or the value_type
of
the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If cross_series_reducer
is specified, then
per_series_aligner
must be specified and not equal to ALIGN_NONE
and alignment_period
must be specified; otherwise, an error is
returned.
.google.monitoring.dashboard.v1.Aggregation.Aligner per_series_aligner = 2;
Returns | |
---|---|
Type | Description |
Aggregation.Aligner | The perSeriesAligner. |
getPerSeriesAlignerValue()
public abstract int getPerSeriesAlignerValue()
An Aligner
describes how to bring the data points in a single
time series into temporal alignment. Except for ALIGN_NONE
, all
alignments cause all the data points in an alignment_period
to be
mathematically grouped together, resulting in a single data point for
each alignment_period
with end timestamp at the end of the period.
Not all alignment operations may be applied to all time series. The valid
choices depend on the metric_kind
and value_type
of the original time
series. Alignment can change the metric_kind
or the value_type
of
the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If cross_series_reducer
is specified, then
per_series_aligner
must be specified and not equal to ALIGN_NONE
and alignment_period
must be specified; otherwise, an error is
returned.
.google.monitoring.dashboard.v1.Aggregation.Aligner per_series_aligner = 2;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for perSeriesAligner. |
hasAlignmentPeriod()
public abstract boolean hasAlignmentPeriod()
The alignment_period
specifies a time interval, in seconds, that is used
to divide the data in all the
time series into consistent blocks of
time. This will be done before the per-series aligner can be applied to
the data.
The value must be at least 60 seconds. If a per-series aligner other than
ALIGN_NONE
is specified, this field is required or an error is returned.
If no per-series aligner is specified, or the aligner ALIGN_NONE
is
specified, then this field is ignored.
The maximum value of the alignment_period
is 2 years, or 104 weeks.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
boolean | Whether the alignmentPeriod field is set. |