Class: Google::Monitoring::V3::ListTimeSeriesRequest
- Inherits:
-
Object
- Object
- Google::Monitoring::V3::ListTimeSeriesRequest
- Defined in:
- lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb
Overview
The +ListTimeSeries+ request.
Defined Under Namespace
Modules: TimeSeriesView
Instance Attribute Summary collapse
-
#aggregation ⇒ Google::Monitoring::V3::Aggregation
By default, the raw time series data is returned.
-
#filter ⇒ String
A monitoring filter that specifies which time series should be returned.
-
#interval ⇒ Google::Monitoring::V3::TimeInterval
The time interval for which results should be returned.
-
#name ⇒ String
The project on which to execute the request.
-
#order_by ⇒ String
Unsupported: must be left blank.
-
#page_size ⇒ Integer
A positive number that is the maximum number of results to return.
-
#page_token ⇒ String
If this field is not empty then it must contain the +nextPageToken+ value returned by a previous call to this method.
-
#view ⇒ Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView
Specifies which information is returned about the time series.
Instance Attribute Details
#aggregation ⇒ Google::Monitoring::V3::Aggregation
Returns By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#filter ⇒ String
Returns A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:
metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.label.instance_name = "my-instance-name"
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#interval ⇒ Google::Monitoring::V3::TimeInterval
Returns The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#name ⇒ String
Returns The project on which to execute the request. The format is "projects/project_id_or_number".
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#order_by ⇒ String
Unsupported: must be left blank. The points in each time series are returned in reverse time order.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#page_size ⇒ Integer
Returns A positive number that is the maximum number of results to return. If +page_size+ is empty or more than 100,000 results, the effective +page_size+ is 100,000 results. If +view+ is set to +FULL+, this is the maximum number of +Points+ returned. If +view+ is set to +HEADERS+, this is the maximum number of +TimeSeries+ returned.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#page_token ⇒ String
If this field is not empty then it must contain the +nextPageToken+ value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |
#view ⇒ Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView
Returns Specifies which information is returned about the time series.
172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb', line 172 class ListTimeSeriesRequest # Controls which fields are returned by +ListTimeSeries+. module TimeSeriesView # Returns the identity of the metric(s), the time series, # and the time series data. FULL = 0 # Returns the identity of the metric and the time series resource, # but not the time series data. HEADERS = 1 end end |