- 3.49.0 (latest)
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public static final class Aggregation.Builder extends GeneratedMessageV3.Builder<Aggregation.Builder> implements AggregationOrBuilder
Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.
Alignment consists of applying the per_series_aligner
operation
to each time series after its data has been divided into regular
alignment_period
time intervals. This process takes all of the data
points in an alignment period, applies a mathematical transformation such as
averaging, minimum, maximum, delta, etc., and converts them into a single
data point per period.
Reduction is when the aligned and transformed time series can optionally be
combined, reducing the number of time series through similar mathematical
transformations. Reduction involves applying a cross_series_reducer
to
all the time series, optionally sorting the time series into subsets with
group_by_fields
, and applying the reducer to each subset.
The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation.
Protobuf type google.monitoring.v3.Aggregation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Aggregation.BuilderImplements
AggregationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllGroupByFields(Iterable<String> values)
public Aggregation.Builder addAllGroupByFields(Iterable<String> values)
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 |
values | Iterable<String> The groupByFields to add. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
addGroupByFields(String value)
public Aggregation.Builder addGroupByFields(String value)
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 |
value | String The groupByFields to add. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
addGroupByFieldsBytes(ByteString value)
public Aggregation.Builder addGroupByFieldsBytes(ByteString value)
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 |
value | ByteString The bytes of the groupByFields to add. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Aggregation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
build()
public Aggregation build()
Returns | |
---|---|
Type | Description |
Aggregation |
buildPartial()
public Aggregation buildPartial()
Returns | |
---|---|
Type | Description |
Aggregation |
clear()
public Aggregation.Builder clear()
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
clearAlignmentPeriod()
public Aggregation.Builder clearAlignmentPeriod()
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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
clearCrossSeriesReducer()
public Aggregation.Builder clearCrossSeriesReducer()
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.v3.Aggregation.Reducer cross_series_reducer = 4;
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Aggregation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
clearGroupByFields()
public Aggregation.Builder clearGroupByFields()
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 |
Aggregation.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Aggregation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
clearPerSeriesAligner()
public Aggregation.Builder clearPerSeriesAligner()
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.v3.Aggregation.Aligner per_series_aligner = 2;
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
clone()
public Aggregation.Builder clone()
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
getAlignmentPeriod()
public 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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
Duration | The alignmentPeriod. |
getAlignmentPeriodBuilder()
public Duration.Builder getAlignmentPeriodBuilder()
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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
Builder |
getAlignmentPeriodOrBuilder()
public 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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getCrossSeriesReducer()
public 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.v3.Aggregation.Reducer cross_series_reducer = 4;
Returns | |
---|---|
Type | Description |
Aggregation.Reducer | The crossSeriesReducer. |
getCrossSeriesReducerValue()
public 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.v3.Aggregation.Reducer cross_series_reducer = 4;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for crossSeriesReducer. |
getDefaultInstanceForType()
public Aggregation getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Aggregation |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getGroupByFields(int index)
public 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 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 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 ProtocolStringList 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 |
ProtocolStringList | A list containing the groupByFields. |
getPerSeriesAligner()
public 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.v3.Aggregation.Aligner per_series_aligner = 2;
Returns | |
---|---|
Type | Description |
Aggregation.Aligner | The perSeriesAligner. |
getPerSeriesAlignerValue()
public 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.v3.Aggregation.Aligner per_series_aligner = 2;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for perSeriesAligner. |
hasAlignmentPeriod()
public 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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Returns | |
---|---|
Type | Description |
boolean | Whether the alignmentPeriod field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeAlignmentPeriod(Duration value)
public Aggregation.Builder mergeAlignmentPeriod(Duration value)
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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
mergeFrom(Aggregation other)
public Aggregation.Builder mergeFrom(Aggregation other)
Parameter | |
---|---|
Name | Description |
other | Aggregation |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Aggregation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Aggregation.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Aggregation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
setAlignmentPeriod(Duration value)
public Aggregation.Builder setAlignmentPeriod(Duration value)
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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Parameter | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
setAlignmentPeriod(Duration.Builder builderForValue)
public Aggregation.Builder setAlignmentPeriod(Duration.Builder builderForValue)
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 104 weeks (2 years) for
charts, and 90,000 seconds (25 hours) for alerting policies.
.google.protobuf.Duration alignment_period = 1;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
setCrossSeriesReducer(Aggregation.Reducer value)
public Aggregation.Builder setCrossSeriesReducer(Aggregation.Reducer value)
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.v3.Aggregation.Reducer cross_series_reducer = 4;
Parameter | |
---|---|
Name | Description |
value | Aggregation.Reducer The crossSeriesReducer to set. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
setCrossSeriesReducerValue(int value)
public Aggregation.Builder setCrossSeriesReducerValue(int value)
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.v3.Aggregation.Reducer cross_series_reducer = 4;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for crossSeriesReducer to set. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Aggregation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
setGroupByFields(int index, String value)
public Aggregation.Builder setGroupByFields(int index, String value)
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;
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The groupByFields to set. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
setPerSeriesAligner(Aggregation.Aligner value)
public Aggregation.Builder setPerSeriesAligner(Aggregation.Aligner value)
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.v3.Aggregation.Aligner per_series_aligner = 2;
Parameter | |
---|---|
Name | Description |
value | Aggregation.Aligner The perSeriesAligner to set. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
setPerSeriesAlignerValue(int value)
public Aggregation.Builder setPerSeriesAlignerValue(int value)
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.v3.Aggregation.Aligner per_series_aligner = 2;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for perSeriesAligner to set. |
Returns | |
---|---|
Type | Description |
Aggregation.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Aggregation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Aggregation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Aggregation.Builder |