Network.Google.Resource.CloudMonitoring.TimeseriesDescriptors.List

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.

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

A resource alias for cloudmonitoring.timeseriesDescriptors.list method which the TimeseriesDescriptorsList request conforms to.

Creating a Request

timeseriesDescriptorsList

Arguments

:: Text

tdlProject

-> ListTimeseriesDescriptorsRequest

tdlPayload

-> Text

tdlMetric

-> Text

tdlYoungest

-> TimeseriesDescriptorsList

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:

• tdlWindow
• tdlProject
• tdlCount
• tdlPayload
• tdlAggregator
• tdlTimespan
• tdlMetric
• tdlOldest
• tdlLabels
• tdlPageToken
• tdlYoungest

data TimeseriesDescriptorsList

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.

Instances

Eq TimeseriesDescriptorsList

Methods

(==) :: TimeseriesDescriptorsList -> TimeseriesDescriptorsList -> Bool

(/=) :: TimeseriesDescriptorsList -> TimeseriesDescriptorsList -> Bool

Data TimeseriesDescriptorsList

Methods

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

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

toConstr :: TimeseriesDescriptorsList -> Constr

dataTypeOf :: TimeseriesDescriptorsList -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> TimeseriesDescriptorsList -> TimeseriesDescriptorsList

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

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

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

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

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

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

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

Show TimeseriesDescriptorsList

Methods

showsPrec :: Int -> TimeseriesDescriptorsList -> ShowS

show :: TimeseriesDescriptorsList -> String

showList :: [TimeseriesDescriptorsList] -> ShowS

Generic TimeseriesDescriptorsList

Associated Types

type Rep TimeseriesDescriptorsList :: * -> *

Methods

from :: TimeseriesDescriptorsList -> Rep TimeseriesDescriptorsList x

to :: Rep TimeseriesDescriptorsList x -> TimeseriesDescriptorsList

GoogleRequest TimeseriesDescriptorsList

Associated Types

type Rs TimeseriesDescriptorsList :: *

type Scopes TimeseriesDescriptorsList :: [Symbol]

Methods

requestClient :: TimeseriesDescriptorsList -> Client (Rs TimeseriesDescriptorsList)

type Rep TimeseriesDescriptorsList

type Rep TimeseriesDescriptorsList = D1 (MetaData "TimeseriesDescriptorsList" "Network.Google.Resource.CloudMonitoring.TimeseriesDescriptors.List" "gogol-cloudmonitoring-0.2.0-96aZdd8ghJU7MrvziRnnxW" False) (C1 (MetaCons "TimeseriesDescriptorsList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdlWindow") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tdlProject") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_tdlCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))) ((:*:) (S1 (MetaSel (Just Symbol "_tdlPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 ListTimeseriesDescriptorsRequest)) (S1 (MetaSel (Just Symbol "_tdlAggregator") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TimeseriesDescriptorsListAggregator)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tdlTimespan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_tdlMetric") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_tdlOldest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_tdlLabels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_tdlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_tdlYoungest") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Scopes TimeseriesDescriptorsList

type Scopes TimeseriesDescriptorsList = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/monitoring" ([] Symbol))

type Rs TimeseriesDescriptorsList

type Rs TimeseriesDescriptorsList = ListTimeseriesDescriptorsResponse

Request Lenses

tdlWindow :: Lens' TimeseriesDescriptorsList (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.

tdlProject :: Lens' TimeseriesDescriptorsList Text

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

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

tdlPayload :: Lens' TimeseriesDescriptorsList ListTimeseriesDescriptorsRequest

Multipart request metadata.

tdlAggregator :: Lens' TimeseriesDescriptorsList (Maybe TimeseriesDescriptorsListAggregator)

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)

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

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)

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]

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)

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

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