com.google.monitoring.v3

Interface AggregationOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Aggregation, Aggregation.Builder

public interface AggregationOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Duration	getAlignmentPeriod() The alignment period for per-[time series][google.monitoring.v3.TimeSeries] alignment.
DurationOrBuilder	getAlignmentPeriodOrBuilder() The alignment period for per-[time series][google.monitoring.v3.TimeSeries] alignment.
Aggregation.Reducer	getCrossSeriesReducer() The approach to be used to combine time series.
int	getCrossSeriesReducerValue() The approach to be used to combine time series.
java.lang.String	getGroupByFields(int index) The set of fields to preserve when `crossSeriesReducer` is specified.
ByteString	getGroupByFieldsBytes(int index) The set of fields to preserve when `crossSeriesReducer` is specified.
int	getGroupByFieldsCount() The set of fields to preserve when `crossSeriesReducer` is specified.
java.util.List<java.lang.String>	getGroupByFieldsList() The set of fields to preserve when `crossSeriesReducer` is specified.
Aggregation.Aligner	getPerSeriesAligner() The approach to be used to align individual time series.
int	getPerSeriesAlignerValue() The approach to be used to align individual time series.
boolean	hasAlignmentPeriod() The alignment period for per-[time series][google.monitoring.v3.TimeSeries] alignment.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasAlignmentPeriod

boolean hasAlignmentPeriod()

 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.
 

.google.protobuf.Duration alignment_period = 1;

getAlignmentPeriod

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.
 

.google.protobuf.Duration alignment_period = 1;

getAlignmentPeriodOrBuilder

DurationOrBuilder getAlignmentPeriodOrBuilder()

 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.
 

.google.protobuf.Duration alignment_period = 1;

getPerSeriesAlignerValue

int getPerSeriesAlignerValue()

 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.
 

.google.monitoring.v3.Aggregation.Aligner per_series_aligner = 2;

getPerSeriesAligner

Aggregation.Aligner 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.
 

.google.monitoring.v3.Aggregation.Aligner per_series_aligner = 2;

getCrossSeriesReducerValue

int getCrossSeriesReducerValue()

 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.
 

.google.monitoring.v3.Aggregation.Reducer cross_series_reducer = 4;

getCrossSeriesReducer

Aggregation.Reducer 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.
 

.google.monitoring.v3.Aggregation.Reducer cross_series_reducer = 4;

getGroupByFieldsList

java.util.List<java.lang.String> getGroupByFieldsList()

 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.
 

repeated string group_by_fields = 5;

getGroupByFieldsCount

int getGroupByFieldsCount()

 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.
 

repeated string group_by_fields = 5;

getGroupByFields

java.lang.String getGroupByFields(int index)

 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.
 

repeated string group_by_fields = 5;

getGroupByFieldsBytes

ByteString getGroupByFieldsBytes(int index)

 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.
 

repeated string group_by_fields = 5;