Copyright | (c) 2015-2016 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 metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be 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.metricDescriptors.list
.
- type MetricDescriptorsListResource = "cloudmonitoring" :> ("v2beta2" :> ("projects" :> (Capture "project" Text :> ("metricDescriptors" :> (QueryParam "count" (Textual Int32) :> (QueryParam "query" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListMetricDescriptorsRequest :> Get '[JSON] ListMetricDescriptorsResponse)))))))))
- metricDescriptorsList :: Text -> ListMetricDescriptorsRequest -> MetricDescriptorsList
- data MetricDescriptorsList
- mdlProject :: Lens' MetricDescriptorsList Text
- mdlCount :: Lens' MetricDescriptorsList Int32
- mdlPayload :: Lens' MetricDescriptorsList ListMetricDescriptorsRequest
- mdlQuery :: Lens' MetricDescriptorsList (Maybe Text)
- mdlPageToken :: Lens' MetricDescriptorsList (Maybe Text)
REST Resource
type MetricDescriptorsListResource = "cloudmonitoring" :> ("v2beta2" :> ("projects" :> (Capture "project" Text :> ("metricDescriptors" :> (QueryParam "count" (Textual Int32) :> (QueryParam "query" Text :> (QueryParam "pageToken" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] ListMetricDescriptorsRequest :> Get '[JSON] ListMetricDescriptorsResponse))))))))) Source #
A resource alias for cloudmonitoring.metricDescriptors.list
method which the
MetricDescriptorsList
request conforms to.
Creating a Request
metricDescriptorsList Source #
Creates a value of MetricDescriptorsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data MetricDescriptorsList Source #
List metric descriptors that match the query. If the query is not set, then all of the metric descriptors will be returned. Large responses will be 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: metricDescriptorsList
smart constructor.
Request Lenses
mdlProject :: Lens' MetricDescriptorsList Text Source #
The project id. The value can be the numeric project ID or string-based project name.
mdlCount :: Lens' MetricDescriptorsList Int32 Source #
Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.
mdlPayload :: Lens' MetricDescriptorsList ListMetricDescriptorsRequest Source #
Multipart request metadata.
mdlQuery :: Lens' MetricDescriptorsList (Maybe Text) Source #
The query used to search against existing metrics. Separate keywords with a space; the service joins all keywords with AND, meaning that all keywords must match for a metric to be returned. If this field is omitted, all metrics are returned. If an empty string is passed with this field, no metrics are returned.
mdlPageToken :: Lens' MetricDescriptorsList (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.