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

Class TimeSeries

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.

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 Cloud 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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
TimeSeries()

Method Summary

Modifier and Type	Method and Description
TimeSeries	clone()
String	getDescription() Input only.
MonitoredResourceMetadata	getMetadata() Output only.
Metric	getMetric() The associated metric.
String	getMetricKind() The metric kind of the time series.
List<Point>	getPoints() The data points of this time series.
MonitoredResource	getResource() The associated monitored resource.
String	getUnit() The units in which the metric value is reported.
String	getValueType() The value type of the time series.
TimeSeries	set(String fieldName, Object value)
TimeSeries	setDescription(String description) Input only.
TimeSeries	setMetadata(MonitoredResourceMetadata metadata) Output only.
TimeSeries	setMetric(Metric metric) The associated metric.
TimeSeries	setMetricKind(String metricKind) The metric kind of the time series.
TimeSeries	setPoints(List<Point> points) The data points of this time series.
TimeSeries	setResource(MonitoredResource resource) The associated monitored resource.
TimeSeries	setUnit(String unit) The units in which the metric value is reported.
TimeSeries	setValueType(String valueType) The value type of the 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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, 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

TimeSeries

public TimeSeries()

Method Detail

getDescription

public String getDescription()

Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.

Returns:

value or null for none

setDescription

public TimeSeries setDescription(String description)

Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.

Parameters:

description - description or null for none

getMetadata

public MonitoredResourceMetadata getMetadata()

Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.

Returns:

value or null for none

setMetadata

public TimeSeries setMetadata(MonitoredResourceMetadata metadata)

Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored.

Parameters:

metadata - metadata or null for none

getMetric

public Metric getMetric()

The associated metric. A fully-specified metric used to identify the time series.

Returns:

value or null for none

setMetric

public TimeSeries setMetric(Metric metric)

The associated metric. A fully-specified metric used to identify the time series.

Parameters:

metric - metric or null for none

getMetricKind

public String getMetricKind()

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

Returns:

value or null for none

setMetricKind

public TimeSeries setMetricKind(String metricKind)

The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.

Parameters:

metricKind - metricKind or null for none

getPoints

public List<Point> getPoints()

The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

Returns:

value or null for none

setPoints

public TimeSeries setPoints(List<Point> points)

The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.

Parameters:

points - points or null for none

getResource

public MonitoredResource getResource()

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).

Returns:

value or null for none

setResource

public TimeSeries setResource(MonitoredResource resource)

The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).

Parameters:

resource - resource or null for none

getUnit

public String getUnit()

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.

Returns:

value or null for none

setUnit

public TimeSeries setUnit(String unit)

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.

Parameters:

unit - unit or null for none

getValueType

public String getValueType()

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

Returns:

value or null for none

setValueType

public TimeSeries setValueType(String valueType)

The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.

Parameters:

valueType - valueType or null for none

set

public TimeSeries set(String fieldName,
                      Object value)

Overrides:

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

clone

public TimeSeries clone()

Overrides:

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