gogol-cloudmonitoring-0.3.0: Google Cloud Monitoring SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.CloudMonitoring.MetricDescriptors.List

Contents

Description

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.

Synopsis

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))))))))) #

A resource alias for cloudmonitoring.metricDescriptors.list method which the MetricDescriptorsList request conforms to.

Creating a Request

metricDescriptorsList #

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 #

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.

Instances

Eq MetricDescriptorsList # 
Data MetricDescriptorsList # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MetricDescriptorsList -> c MetricDescriptorsList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MetricDescriptorsList #

toConstr :: MetricDescriptorsList -> Constr #

dataTypeOf :: MetricDescriptorsList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c MetricDescriptorsList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MetricDescriptorsList) #

gmapT :: (forall b. Data b => b -> b) -> MetricDescriptorsList -> MetricDescriptorsList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MetricDescriptorsList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MetricDescriptorsList -> r #

gmapQ :: (forall d. Data d => d -> u) -> MetricDescriptorsList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> MetricDescriptorsList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MetricDescriptorsList -> m MetricDescriptorsList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MetricDescriptorsList -> m MetricDescriptorsList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MetricDescriptorsList -> m MetricDescriptorsList #

Show MetricDescriptorsList # 
Generic MetricDescriptorsList # 
GoogleRequest MetricDescriptorsList # 
type Rep MetricDescriptorsList # 
type Rep MetricDescriptorsList = D1 (MetaData "MetricDescriptorsList" "Network.Google.Resource.CloudMonitoring.MetricDescriptors.List" "gogol-cloudmonitoring-0.3.0-4WbW1sBfqwm99GEiC4AmI7" False) (C1 (MetaCons "MetricDescriptorsList'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mdlProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_mdlCount") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 (Textual Int32)))) ((:*:) (S1 (MetaSel (Just Symbol "_mdlPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ListMetricDescriptorsRequest)) ((:*:) (S1 (MetaSel (Just Symbol "_mdlQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mdlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes MetricDescriptorsList # 
type Scopes MetricDescriptorsList = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/monitoring" ([] Symbol))
type Rs MetricDescriptorsList # 

Request Lenses

mdlProject :: Lens' MetricDescriptorsList Text #

The project id. The value can be the numeric project ID or string-based project name.

mdlCount :: Lens' MetricDescriptorsList Int32 #

Maximum number of metric descriptors per page. Used for pagination. If not specified, count = 100.

mdlQuery :: Lens' MetricDescriptorsList (Maybe Text) #

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) #

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.