Aggregation
class Aggregation extends Message
Describes how to combine multiple time series to provide different views of
the data. Aggregation consists of an alignment step on individual time
series (per_series_aligner) followed by an optional reduction of the data
across different time series (cross_series_reducer). For more details, see
Aggregation.
Protobuf type Google\Monitoring\V3\Aggregation
Methods
No description
The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present, alignmentPeriod must be at least 60
seconds. After per-time series alignment, each time series will
contain data points only on the period boundaries. If
perSeriesAligner is not specified or equals ALIGN_NONE, then
this field is ignored. If perSeriesAligner is specified and
does not equal ALIGN_NONE, then this field must be defined;
otherwise an error is returned.
The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present, alignmentPeriod must be at least 60
seconds. After per-time series alignment, each time series will
contain data points only on the period boundaries. If
perSeriesAligner is not specified or equals ALIGN_NONE, then
this field is ignored. If perSeriesAligner is specified and
does not equal ALIGN_NONE, then this field must be defined;
otherwise an error is returned.
The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
The set of fields to preserve when crossSeriesReducer is
specified. The groupByFields determine how the time series are
partitioned into subsets prior to applying the aggregation
function. 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
crossSeriesReducer is applied to each subset of time series.
The set of fields to preserve when crossSeriesReducer is
specified. The groupByFields determine how the time series are
partitioned into subsets prior to applying the aggregation
function. 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
crossSeriesReducer is applied to each subset of time series.
Details
at line 85
__construct()
at line 103
Duration
getAlignmentPeriod()
The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present, alignmentPeriod must be at least 60
seconds. After per-time series alignment, each time series will
contain data points only on the period boundaries. If
perSeriesAligner is not specified or equals ALIGN_NONE, then
this field is ignored. If perSeriesAligner is specified and
does not equal ALIGN_NONE, then this field must be defined;
otherwise an error is returned.
Generated from protobuf field .google.protobuf.Duration alignment_period = 1;
at line 121
setAlignmentPeriod(Duration $var)
The alignment period for per-[time series][google.monitoring.v3.TimeSeries]
alignment. If present, alignmentPeriod must be at least 60
seconds. After per-time series alignment, each time series will
contain data points only on the period boundaries. If
perSeriesAligner is not specified or equals ALIGN_NONE, then
this field is ignored. If perSeriesAligner is specified and
does not equal ALIGN_NONE, then this field must be defined;
otherwise an error is returned.
Generated from protobuf field .google.protobuf.Duration alignment_period = 1;
at line 142
int
getPerSeriesAligner()
The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If crossSeriesReducer is specified, then
perSeriesAligner must be specified and not equal ALIGN_NONE
and alignmentPeriod must be specified; otherwise, an error is
returned.
Generated from protobuf field .google.monitoring.v3.Aggregation.Aligner per_series_aligner = 2;
at line 162
setPerSeriesAligner(int $var)
The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If crossSeriesReducer is specified, then
perSeriesAligner must be specified and not equal ALIGN_NONE
and alignmentPeriod must be specified; otherwise, an error is
returned.
Generated from protobuf field .google.monitoring.v3.Aggregation.Aligner per_series_aligner = 2;
at line 183
int
getCrossSeriesReducer()
The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If crossSeriesReducer is specified, then
perSeriesAligner must be specified and not equal ALIGN_NONE
and alignmentPeriod must be specified; otherwise, an error is
returned.
Generated from protobuf field .google.monitoring.v3.Aggregation.Reducer cross_series_reducer = 4;
at line 203
setCrossSeriesReducer(int $var)
The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.
Time series data must be aligned in order to perform cross-time
series reduction. If crossSeriesReducer is specified, then
perSeriesAligner must be specified and not equal ALIGN_NONE
and alignmentPeriod must be specified; otherwise, an error is
returned.
Generated from protobuf field .google.monitoring.v3.Aggregation.Reducer cross_series_reducer = 4;
at line 228
RepeatedField
getGroupByFields()
The set of fields to preserve when crossSeriesReducer is
specified. The groupByFields determine how the time series are
partitioned into subsets prior to applying the aggregation
function. 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
crossSeriesReducer 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 groupByFields are aggregated away. If
groupByFields 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 crossSeriesReducer is not
defined, this field is ignored.
Generated from protobuf field repeated string group_by_fields = 5;
at line 252
setGroupByFields(array|RepeatedField $var)
The set of fields to preserve when crossSeriesReducer is
specified. The groupByFields determine how the time series are
partitioned into subsets prior to applying the aggregation
function. 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
crossSeriesReducer 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 groupByFields are aggregated away. If
groupByFields 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 crossSeriesReducer is not
defined, this field is ignored.
Generated from protobuf field repeated string group_by_fields = 5;