Google Cloud Monitoring v3 API - Class TimeSeries (3.4.0)

public sealed class TimeSeries : IMessage<TimeSeries>, IEquatable<TimeSeries>, IDeepCloneable<TimeSeries>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Monitoring v3 API class TimeSeries.

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.

Inheritance

object > TimeSeries

Namespace

Google.Cloud.Monitoring.V3

Assembly

Google.Cloud.Monitoring.V3.dll

Constructors

TimeSeries()

public TimeSeries()

TimeSeries(TimeSeries)

public TimeSeries(TimeSeries other)
Parameter
NameDescription
otherTimeSeries

Properties

Metadata

public MonitoredResourceMetadata Metadata { get; set; }

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.

Property Value
TypeDescription
MonitoredResourceMetadata

Metric

public Metric Metric { get; set; }

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

Property Value
TypeDescription
Metric

MetricKind

public MetricDescriptor.Types.MetricKind MetricKind { get; set; }

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.

Property Value
TypeDescription
MetricDescriptorTypesMetricKind

Points

public RepeatedField<Point> Points { get; }

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.

Property Value
TypeDescription
RepeatedFieldPoint

Resource

public MonitoredResource Resource { get; set; }

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.

Property Value
TypeDescription
MonitoredResource

Unit

public string Unit { get; set; }

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.

Property Value
TypeDescription
string

ValueType

public MetricDescriptor.Types.ValueType ValueType { get; set; }

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.

Property Value
TypeDescription
MetricDescriptorTypesValueType