Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::ListTimeSeriesRequest (v1.0.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListTimeSeriesRequest.

The ListTimeSeries request.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#aggregation

def aggregation() -> ::Google::Cloud::Monitoring::V3::Aggregation

Returns

(::Google::Cloud::Monitoring::V3::Aggregation) — Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

#aggregation=

def aggregation=(value) -> ::Google::Cloud::Monitoring::V3::Aggregation

Parameter

value (::Google::Cloud::Monitoring::V3::Aggregation) — Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

Returns

(::Google::Cloud::Monitoring::V3::Aggregation) — Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

#filter

def filter() -> ::String

Returns

(::String) —
Required. 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.labels.instance_name = "my-instance-name"
```

#filter=

def filter=(value) -> ::String

Parameter

value (::String) —
Required. 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.labels.instance_name = "my-instance-name"
```

Returns

(::String) —
Required. 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.labels.instance_name = "my-instance-name"
```

#interval

def interval() -> ::Google::Cloud::Monitoring::V3::TimeInterval

Returns

(::Google::Cloud::Monitoring::V3::TimeInterval) — Required. 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.

#interval=

def interval=(value) -> ::Google::Cloud::Monitoring::V3::TimeInterval

Parameter

value (::Google::Cloud::Monitoring::V3::TimeInterval) — Required. 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.

Returns

(::Google::Cloud::Monitoring::V3::TimeInterval) — Required. 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.

#name

def name() -> ::String

Returns

(::String) —
Required. The project, organization or folder on which to execute the request. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]
```

#name=

def name=(value) -> ::String

Parameter

value (::String) —
Required. The project, organization or folder on which to execute the request. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]
```

Returns

(::String) —
Required. The project, organization or folder on which to execute the request. The format is:
```
projects/[PROJECT_ID_OR_NUMBER]
organizations/[ORGANIZATION_ID]
folders/[FOLDER_ID]
```

#order_by

def order_by() -> ::String

Returns

(::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

#order_by=

def order_by=(value) -> ::String

Parameter

value (::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

Returns

(::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

#page_size

def page_size() -> ::Integer

Returns

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

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

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

#page_token

def page_token() -> ::String

Returns

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

#page_token=

def page_token=(value) -> ::String

Parameter

value (::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.

Returns

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

#secondary_aggregation

def secondary_aggregation() -> ::Google::Cloud::Monitoring::V3::Aggregation

Returns

(::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

#secondary_aggregation=

def secondary_aggregation=(value) -> ::Google::Cloud::Monitoring::V3::Aggregation

Parameter

value (::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

Returns

(::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

#view

def view() -> ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView

Returns

(::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.

#view=

def view=(value) -> ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView

Parameter

value (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.

Returns

(::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.