Class: Google::Monitoring::V3::TimeSeries

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#metadata ⇒ Google::Api::MonitoredResourceMetadata

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

Returns:

  • (Google::Api::MonitoredResourceMetadata) —

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



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end

#metric ⇒ Google::Api::Metric

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

Returns:

  • (Google::Api::Metric) —

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



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end

#metric_kind ⇒ Google::Api::MetricDescriptor::MetricKind

Returns 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:

  • (Google::Api::MetricDescriptor::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+.



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end

#points ⇒ Array<Google::Monitoring::V3::Point>

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:

  • (Array<Google::Monitoring::V3::Point>) —

    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+.



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end

#resource ⇒ Google::Api::MonitoredResource

Returns The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.

Returns:

  • (Google::Api::MonitoredResource) —

    The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end

#value_type ⇒ Google::Api::MetricDescriptor::ValueType

Returns 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:

  • (Google::Api::MetricDescriptor::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.



80
 
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb', line 80

class TimeSeries; end