Class ListTimeSeriesRequest (2.19.2)

ListTimeSeriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The ListTimeSeries request.

Attributes

NameDescription
name str
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]
filter str
Required. A `monitoring filter
interval google.cloud.monitoring_v3.types.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.
aggregation google.cloud.monitoring_v3.types.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.
secondary_aggregation google.cloud.monitoring_v3.types.Aggregation
Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.
order_by str
Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
view google.cloud.monitoring_v3.types.ListTimeSeriesRequest.TimeSeriesView
Required. Specifies which information is returned about the time series.
page_size int
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 str
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.

Classes

TimeSeriesView

TimeSeriesView(value)

Controls which fields are returned by ListTimeSeries.

Values: FULL (0): Returns the identity of the metric(s), the time series, and the time series data. HEADERS (1): Returns the identity of the metric and the time series resource, but not the time series data.