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.
Implements
Inherited Members
Namespace: Google.Apis.Monitoring.v3.Data
Assembly: Google.Apis.Monitoring.v3.dll
Syntax
public class TimeSeries : IDirectResponseSchema
Properties
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.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("metadata")]
public virtual MonitoredResourceMetadata Metadata { get; set; }
Property Value
Type | Description |
---|---|
MonitoredResourceMetadata |
Metric
The associated metric. A fully-specified metric used to identify the time series.
Declaration
[JsonProperty("metric")]
public virtual Metric Metric { get; set; }
Property Value
Type | Description |
---|---|
Metric |
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.
Declaration
[JsonProperty("metricKind")]
public virtual string MetricKind { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("points")]
public virtual IList<Point> Points { get; set; }
Property Value
Type | Description |
---|---|
IList<Point> |
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).
Declaration
[JsonProperty("resource")]
public virtual MonitoredResource Resource { get; set; }
Property Value
Type | Description |
---|---|
MonitoredResource |
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.
Declaration
[JsonProperty("unit")]
public virtual string Unit { get; set; }
Property Value
Type | Description |
---|---|
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.
Declaration
[JsonProperty("valueType")]
public virtual string ValueType { get; set; }
Property Value
Type | Description |
---|---|
string |