# Cloud Monitoring Dashboards V1 API - Class Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery (v1.7.0)

1.7.0 (latest) 1.6.0 1.5.0 1.4.1 1.3.0 1.2.1 1.1.0 1.0.1 0.16.0 0.15.0 0.14.2 0.13.0 0.12.1 0.11.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.6 Reference documentation and code samples for the Cloud Monitoring Dashboards V1 API class Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery.

TimeSeriesQuery collects the set of supported methods for querying time
series data from the Stackdriver metrics API.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #output_full_duration

    def output_full_duration() -> ::Boolean

**Returns**

- (::Boolean) --- Optional. If set, Cloud Monitoring will treat the full query duration as
  the alignment period so that there will be only 1 output value.

  \*Note: This could override the configured alignment period except for
  the cases where a series of data points are expected, like
  - XyChart
  - Scorecard's spark chart

### #output_full_duration=

    def output_full_duration=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) ---

  Optional. If set, Cloud Monitoring will treat the full query duration as
  the alignment period so that there will be only 1 output value.

  \*Note: This could override the configured alignment period except for
  the cases where a series of data points are expected, like
  - XyChart
  - Scorecard's spark chart
**Returns**

- (::Boolean) --- Optional. If set, Cloud Monitoring will treat the full query duration as
  the alignment period so that there will be only 1 output value.

  \*Note: This could override the configured alignment period except for
  the cases where a series of data points are expected, like
  - XyChart
  - Scorecard's spark chart

### #prometheus_query

    def prometheus_query() -> ::String

**Returns**

- (::String) --- A query used to fetch time series with PromQL.

  Note: The following fields are mutually exclusive: `prometheus_query`, `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #prometheus_query=

    def prometheus_query=(value) -> ::String

**Parameter**

- **value** (::String) --- A query used to fetch time series with PromQL.


  Note: The following fields are mutually exclusive: `prometheus_query`, `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- (::String) --- A query used to fetch time series with PromQL.

  Note: The following fields are mutually exclusive: `prometheus_query`, `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_filter

    def time_series_filter() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter

**Returns**

- ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilter)) --- Filter parameters to fetch time series.


  Note: The following fields are mutually exclusive: `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_filter=

    def time_series_filter=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter

**Parameter**

- **value** ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilter)) --- Filter parameters to fetch time series.


  Note: The following fields are mutually exclusive: `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilter)) --- Filter parameters to fetch time series.


  Note: The following fields are mutually exclusive: `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_filter_ratio

    def time_series_filter_ratio() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio

**Returns**

- ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilterRatio)) --- Parameters to fetch a ratio between two time series filters.


  Note: The following fields are mutually exclusive: `time_series_filter_ratio`, `time_series_filter`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_filter_ratio=

    def time_series_filter_ratio=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio

**Parameter**

- **value** ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilterRatio)) --- Parameters to fetch a ratio between two time series filters.


  Note: The following fields are mutually exclusive: `time_series_filter_ratio`, `time_series_filter`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- ([::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-dashboard-v1/latest/Google-Cloud-Monitoring-Dashboard-V1-TimeSeriesFilterRatio)) --- Parameters to fetch a ratio between two time series filters.


  Note: The following fields are mutually exclusive: `time_series_filter_ratio`, `time_series_filter`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_query_language

    def time_series_query_language() -> ::String

**Returns**

- (::String) --- A query used to fetch time series with MQL.

  Note: The following fields are mutually exclusive: `time_series_query_language`, `time_series_filter`, `time_series_filter_ratio`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #time_series_query_language=

    def time_series_query_language=(value) -> ::String

**Parameter**

- **value** (::String) --- A query used to fetch time series with MQL.


  Note: The following fields are mutually exclusive: `time_series_query_language`, `time_series_filter`, `time_series_filter_ratio`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
**Returns**

- (::String) --- A query used to fetch time series with MQL.

  Note: The following fields are mutually exclusive: `time_series_query_language`, `time_series_filter`, `time_series_filter_ratio`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.

### #unit_override

    def unit_override() -> ::String

**Returns**

- (::String) --- The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in `MetricDescriptor`.

### #unit_override=

    def unit_override=(value) -> ::String

**Parameter**

- **value** (::String) --- The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in `MetricDescriptor`.
**Returns**

- (::String) --- The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in `MetricDescriptor`.