# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::TimeSeries (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.0 1.7.1 1.6.1 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.0 0.16.0 0.15.2 0.14.0 0.13.0 0.12.1 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #description

    def description() -> ::String

**Returns**

- (::String) --- Input only. A detailed description of the time series that will be associated with the [google.api.MetricDescriptor](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MetricDescriptor "Google::Api::MetricDescriptor (class)") for the metric. Once set, this field cannot be changed through CreateTimeSeries.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- Input only. A detailed description of the time series that will be associated with the [google.api.MetricDescriptor](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MetricDescriptor "Google::Api::MetricDescriptor (class)") for the metric. Once set, this field cannot be changed through CreateTimeSeries.
**Returns**

- (::String) --- Input only. A detailed description of the time series that will be associated with the [google.api.MetricDescriptor](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MetricDescriptor "Google::Api::MetricDescriptor (class)") for the metric. Once set, this field cannot be changed through CreateTimeSeries.

### #metadata

    def metadata() -> ::Google::Api::MonitoredResourceMetadata

**Returns**

- ([::Google::Api::MonitoredResourceMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResourceMetadata)) --- 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.

### #metadata=

    def metadata=(value) -> ::Google::Api::MonitoredResourceMetadata

**Parameter**

- **value** ([::Google::Api::MonitoredResourceMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResourceMetadata)) --- 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**

- ([::Google::Api::MonitoredResourceMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResourceMetadata)) --- 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.

### #metric

    def metric() -> ::Google::Api::Metric

**Returns**

- ([::Google::Api::Metric](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-Metric)) --- The associated metric. A fully-specified metric used to identify the time series.

### #metric=

    def metric=(value) -> ::Google::Api::Metric

**Parameter**

- **value** ([::Google::Api::Metric](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-Metric)) --- The associated metric. A fully-specified metric used to identify the time series.
**Returns**

- ([::Google::Api::Metric](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-Metric)) --- The associated metric. A fully-specified metric used to identify the time series.

### #metric_kind

    def metric_kind() -> ::Google::Api::MetricDescriptor::MetricKind

**Returns**

- ([::Google::Api::MetricDescriptor::MetricKind](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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`.

### #metric_kind=

    def metric_kind=(value) -> ::Google::Api::MetricDescriptor::MetricKind

**Parameter**

- **value** ([::Google::Api::MetricDescriptor::MetricKind](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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`.
**Returns**

- ([::Google::Api::MetricDescriptor::MetricKind](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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`.

### #points

    def points() -> ::Array<::Google::Cloud::Monitoring::V3::Point>

**Returns**

- (::Array\<[::Google::Cloud::Monitoring::V3::Point](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-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`.

### #points=

    def points=(value) -> ::Array<::Google::Cloud::Monitoring::V3::Point>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Monitoring::V3::Point](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-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::Cloud::Monitoring::V3::Point](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-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`.

### #resource

    def resource() -> ::Google::Api::MonitoredResource

**Returns**

- ([::Google::Api::MonitoredResource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResource)) --- 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).

### #resource=

    def resource=(value) -> ::Google::Api::MonitoredResource

**Parameter**

- **value** ([::Google::Api::MonitoredResource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResource)) --- 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**

- ([::Google::Api::MonitoredResource](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Api-MonitoredResource)) --- 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).

### #unit

    def unit() -> ::String

**Returns**

- (::String) --- 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.

### #unit=

    def unit=(value) -> ::String

**Parameter**

- **value** (::String) --- 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**

- (::String) --- 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.

### #value_type

    def value_type() -> ::Google::Api::MetricDescriptor::ValueType

**Returns**

- ([::Google::Api::MetricDescriptor::ValueType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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.

### #value_type=

    def value_type=(value) -> ::Google::Api::MetricDescriptor::ValueType

**Parameter**

- **value** ([::Google::Api::MetricDescriptor::ValueType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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.
**Returns**

- ([::Google::Api::MetricDescriptor::ValueType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/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.