Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
List the descriptors 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.timeseriesDescriptors.list
.
- type TimeseriesDescriptorsListResource = "cloudmonitoring" :> ("v2beta2" :> ("projects" :> (Capture "project" Text :> ("timeseriesDescriptors" :> (Capture "metric" Text :> (QueryParam "youngest" Text :> (QueryParam "window" Text :> (QueryParam "count" (Textual Int32) :> (QueryParam "aggregator" TimeseriesDescriptorsListAggregator :> (QueryParam "timespan" Text :> (QueryParam "oldest" Text :> (QueryParams "labels" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` ListTimeseriesDescriptorsRequest :> Get `[JSON]` ListTimeseriesDescriptorsResponse)))))))))))))))
- timeseriesDescriptorsList :: Text -> ListTimeseriesDescriptorsRequest -> Text -> Text -> TimeseriesDescriptorsList
- data TimeseriesDescriptorsList
- tdlWindow :: Lens' TimeseriesDescriptorsList (Maybe Text)
- tdlProject :: Lens' TimeseriesDescriptorsList Text
- tdlCount :: Lens' TimeseriesDescriptorsList Int32
- tdlPayload :: Lens' TimeseriesDescriptorsList ListTimeseriesDescriptorsRequest
- tdlAggregator :: Lens' TimeseriesDescriptorsList (Maybe TimeseriesDescriptorsListAggregator)
- tdlTimespan :: Lens' TimeseriesDescriptorsList (Maybe Text)
- tdlMetric :: Lens' TimeseriesDescriptorsList Text
- tdlOldest :: Lens' TimeseriesDescriptorsList (Maybe Text)
- tdlLabels :: Lens' TimeseriesDescriptorsList [Text]
- tdlPageToken :: Lens' TimeseriesDescriptorsList (Maybe Text)
- tdlYoungest :: Lens' TimeseriesDescriptorsList Text
REST Resource
type TimeseriesDescriptorsListResource = "cloudmonitoring" :> ("v2beta2" :> ("projects" :> (Capture "project" Text :> ("timeseriesDescriptors" :> (Capture "metric" Text :> (QueryParam "youngest" Text :> (QueryParam "window" Text :> (QueryParam "count" (Textual Int32) :> (QueryParam "aggregator" TimeseriesDescriptorsListAggregator :> (QueryParam "timespan" Text :> (QueryParam "oldest" Text :> (QueryParams "labels" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` ListTimeseriesDescriptorsRequest :> Get `[JSON]` ListTimeseriesDescriptorsResponse))))))))))))))) Source
A resource alias for cloudmonitoring.timeseriesDescriptors.list
method which the
TimeseriesDescriptorsList
request conforms to.
Creating a Request
timeseriesDescriptorsList Source
Creates a value of TimeseriesDescriptorsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TimeseriesDescriptorsList Source
List the descriptors 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: timeseriesDescriptorsList
smart constructor.
Request Lenses
tdlWindow :: Lens' TimeseriesDescriptorsList (Maybe Text) Source
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.
tdlProject :: Lens' TimeseriesDescriptorsList Text Source
The project ID to which this time series belongs. The value can be the numeric project ID or string-based project name.
tdlCount :: Lens' TimeseriesDescriptorsList Int32 Source
Maximum number of time series descriptors per page. Used for pagination. If not specified, count = 100.
tdlPayload :: Lens' TimeseriesDescriptorsList ListTimeseriesDescriptorsRequest Source
Multipart request metadata.
tdlAggregator :: Lens' TimeseriesDescriptorsList (Maybe TimeseriesDescriptorsListAggregator) Source
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.
tdlTimespan :: Lens' TimeseriesDescriptorsList (Maybe Text) Source
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].
tdlMetric :: Lens' TimeseriesDescriptorsList Text Source
Metric names are protocol-free URLs as listed in the Supported Metrics page. For example, compute.googleapis.com/instance/disk/read_ops_count.
tdlOldest :: Lens' TimeseriesDescriptorsList (Maybe Text) Source
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]
tdlLabels :: Lens' TimeseriesDescriptorsList [Text] Source
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.*
tdlPageToken :: Lens' TimeseriesDescriptorsList (Maybe Text) Source
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.
tdlYoungest :: Lens' TimeseriesDescriptorsList Text Source
End of the time interval (inclusive), which is expressed as an RFC 3339 timestamp.