com.google.api.services.monitoring.v3.model

Class Aggregation

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.Aggregation

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Aggregation
extends com.google.api.client.json.GenericJson

Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Stackdriver Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Aggregation()

Method Summary

Modifier and Type	Method and Description
Aggregation	clone()
java.lang.String	getAlignmentPeriod() The alignment period for per-time series alignment.
java.lang.String	getCrossSeriesReducer() The approach to be used to combine time series.
java.util.List<java.lang.String>	getGroupByFields() The set of fields to preserve when crossSeriesReducer is specified.
java.lang.String	getPerSeriesAligner() The approach to be used to align individual time series.
Aggregation	set(java.lang.String fieldName, java.lang.Object value)
Aggregation	setAlignmentPeriod(java.lang.String alignmentPeriod) The alignment period for per-time series alignment.
Aggregation	setCrossSeriesReducer(java.lang.String crossSeriesReducer) The approach to be used to combine time series.
Aggregation	setGroupByFields(java.util.List<java.lang.String> groupByFields) The set of fields to preserve when crossSeriesReducer is specified.
Aggregation	setPerSeriesAligner(java.lang.String perSeriesAligner) The approach to be used to align individual time series.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Aggregation

public Aggregation()

Method Detail

getAlignmentPeriod

public java.lang.String getAlignmentPeriod()

The alignment period for per-time series 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.

Returns:

value or null for none

setAlignmentPeriod

public Aggregation setAlignmentPeriod(java.lang.String alignmentPeriod)

The alignment period for per-time series 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.

Parameters:

alignmentPeriod - alignmentPeriod or null for none

getCrossSeriesReducer

public java.lang.String 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.

Returns:

value or null for none

setCrossSeriesReducer

public Aggregation setCrossSeriesReducer(java.lang.String crossSeriesReducer)

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.

Parameters:

crossSeriesReducer - crossSeriesReducer or null for none

getGroupByFields

public java.util.List<java.lang.String> 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.

Returns:

value or null for none

setGroupByFields

public Aggregation setGroupByFields(java.util.List<java.lang.String> groupByFields)

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.

Parameters:

groupByFields - groupByFields or null for none

getPerSeriesAligner

public java.lang.String 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.

Returns:

value or null for none

setPerSeriesAligner

public Aggregation setPerSeriesAligner(java.lang.String perSeriesAligner)

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.

Parameters:

perSeriesAligner - perSeriesAligner or null for none

set

public Aggregation set(java.lang.String fieldName,
                       java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Aggregation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson