Package com.google.monitoring.v3

Interface AggregationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Aggregation, Aggregation.Builder
    public interface AggregationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getAlignmentPeriod()
      The `alignment_period` specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time.
      com.google.protobuf.DurationOrBuilder getAlignmentPeriodOrBuilder()
      The `alignment_period` specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time.
      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.
      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.
      String getGroupByFields​(int index)
      The set of fields to preserve when `cross_series_reducer` is specified.
      com.google.protobuf.ByteString getGroupByFieldsBytes​(int index)
      The set of fields to preserve when `cross_series_reducer` is specified.
      int getGroupByFieldsCount()
      The set of fields to preserve when `cross_series_reducer` is specified.
      List<String> getGroupByFieldsList()
      The set of fields to preserve when `cross_series_reducer` is specified.
      Aggregation.Aligner getPerSeriesAligner()
      An `Aligner` describes how to bring the data points in a single time series into temporal alignment.
      int getPerSeriesAlignerValue()
      An `Aligner` describes how to bring the data points in a single time series into temporal alignment.
      boolean hasAlignmentPeriod()
      The `alignment_period` specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasAlignmentPeriod

        boolean hasAlignmentPeriod()
         The `alignment_period` specifies a time interval, in seconds, that is used
 to divide the data in all the
 [time series][google.monitoring.v3.TimeSeries] 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:
        Whether the alignmentPeriod field is set.

      • getAlignmentPeriod

        com.google.protobuf.Duration getAlignmentPeriod()
         The `alignment_period` specifies a time interval, in seconds, that is used
 to divide the data in all the
 [time series][google.monitoring.v3.TimeSeries] 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:
        The alignmentPeriod.

      • getAlignmentPeriodOrBuilder

        com.google.protobuf.DurationOrBuilder getAlignmentPeriodOrBuilder()
         The `alignment_period` specifies a time interval, in seconds, that is used
 to divide the data in all the
 [time series][google.monitoring.v3.TimeSeries] 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;

      • getPerSeriesAlignerValue

        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:
        The enum numeric value on the wire for perSeriesAligner.

      • getPerSeriesAligner

        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:
        The perSeriesAligner.

      • getCrossSeriesReducerValue

        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:
        The enum numeric value on the wire for crossSeriesReducer.

      • getCrossSeriesReducer

        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:
        The crossSeriesReducer.

      • getGroupByFieldsList

        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:
        A list containing the groupByFields.

      • getGroupByFieldsCount

        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:
        The count of groupByFields.

      • getGroupByFields

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The groupByFields at the given index.

      • getGroupByFieldsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the groupByFields at the given index.