Network.Google.Resource.CloudMonitoring.Timeseries.List

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

See: Cloud Monitoring API Reference for cloudmonitoring.timeseries.list.

REST Resource

type TimeseriesListResource = "cloudmonitoring" :> ("v2beta2" :> ("projects" :> (Capture "project" Text :> ("timeseries" :> (Capture "metric" Text :> (QueryParam "youngest" Text :> (QueryParam "window" Text :> (QueryParam "count" (Textual Int32) :> (QueryParam "aggregator" TimeseriesListAggregator :> (QueryParam "timespan" Text :> (QueryParam "oldest" Text :> (QueryParams "labels" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` ListTimeseriesRequest :> Get `[JSON]` ListTimeseriesResponse)))))))))))))))

A resource alias for cloudmonitoring.timeseries.list method which the TimeseriesList request conforms to.

Creating a Request

timeseriesList

Arguments

:: Text

tlProject

-> ListTimeseriesRequest

tlPayload

-> Text

tlMetric

-> Text

tlYoungest

-> TimeseriesList

Creates a value of TimeseriesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tlWindow
• tlProject
• tlCount
• tlPayload
• tlAggregator
• tlTimespan
• tlMetric
• tlOldest
• tlLabels
• tlPageToken
• tlYoungest

data TimeseriesList

List the data points of the time series that match the metric and labels values and that have data points in the interval. Large responses are paginated; use the nextPageToken returned in the response to request subsequent pages of results by setting the pageToken query parameter to the value of the nextPageToken.

See: timeseriesList smart constructor.

Instances

Eq TimeseriesList

Data TimeseriesList

Show TimeseriesList

Generic TimeseriesList

GoogleRequest TimeseriesList

type Rep TimeseriesList

type Rs TimeseriesList = ListTimeseriesResponse

Request Lenses

tlWindow :: Lens' TimeseriesList (Maybe Text)

The sampling window. At most one data point will be returned for each window in the requested time interval. This parameter is only valid for non-cumulative metric types. Units: - m: minute - h: hour - d: day - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead.

tlProject :: Lens' TimeseriesList Text

The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.

tlCount :: Lens' TimeseriesList Int32

Maximum number of data points per page, which is used for pagination of results.

tlPayload :: Lens' TimeseriesList ListTimeseriesRequest

Multipart request metadata.

tlAggregator :: Lens' TimeseriesList (Maybe TimeseriesListAggregator)

The aggregation function that will reduce the data points in each window to a single point. This parameter is only valid for non-cumulative metrics with a value type of INT64 or DOUBLE.

tlTimespan :: Lens' TimeseriesList (Maybe Text)

Length of the time interval to query, which is an alternative way to declare the interval: (youngest - timespan, youngest]. The timespan and oldest parameters should not be used together. Units: - s: second - m: minute - h: hour - d: day - w: week Examples: 2s, 3m, 4w. Only one unit is allowed, for example: 2w3d is not allowed; you should use 17d instead. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest].

tlMetric :: Lens' TimeseriesList Text

Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.

tlOldest :: Lens' TimeseriesList (Maybe Text)

Start of the time interval (exclusive), which is expressed as an RFC 3339 timestamp. If neither oldest nor timespan is specified, the default time interval will be (youngest - 4 hours, youngest]

tlLabels :: Lens' TimeseriesList [Text]

A collection of labels for the matching time series, which are represented as: - key==value: key equals the value - key=~value: key regex matches the value - key!=value: key does not equal the value - key!~value: key regex does not match the value For example, to list all of the time series descriptors for the region us-central1, you could specify: label=cloud.googleapis.com%2Flocation=~us-central1.*

tlPageToken :: Lens' TimeseriesList (Maybe Text)

The pagination token, which is used to page through large result sets. Set this value to the value of the nextPageToken to retrieve the next page of results.

tlYoungest :: Lens' TimeseriesList Text

End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.