gogol-monitoring-0.1.0: Google 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.Monitoring.Projects.TimeSeries.List

Contents

Description

Lists time series that match a filter. This method does not require a Stackdriver account.

See: Google Monitoring API Reference for monitoring.projects.timeSeries.list.

Synopsis

REST Resource

type ProjectsTimeSeriesListResource = "v3" :> (Capture "name" Text :> ("timeSeries" :> (QueryParam "interval.startTime" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "aggregation.perSeriesAligner" Text :> (QueryParam "bearer_token" Text :> (QueryParams "aggregation.groupByFields" Text :> (QueryParam "view" Text :> (QueryParam "aggregation.crossSeriesReducer" Text :> (QueryParam "filter" Text :> (QueryParam "aggregation.alignmentPeriod" Text :> (QueryParam "pageToken" Text :> (QueryParam "interval.endTime" Text :> (QueryParam "pageSize" (Textual Int32) :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] ListTimeSeriesResponse))))))))))))))))))))) Source #

A resource alias for monitoring.projects.timeSeries.list method which the ProjectsTimeSeriesList request conforms to.

Creating a Request

data ProjectsTimeSeriesList Source #

Lists time series that match a filter. This method does not require a Stackdriver account.

See: projectsTimeSeriesList smart constructor.

Instances

Eq ProjectsTimeSeriesList Source # 
Data ProjectsTimeSeriesList Source # 

Methods

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

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

toConstr :: ProjectsTimeSeriesList -> Constr #

dataTypeOf :: ProjectsTimeSeriesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show ProjectsTimeSeriesList Source # 
Generic ProjectsTimeSeriesList Source # 
GoogleRequest ProjectsTimeSeriesList Source # 
type Rep ProjectsTimeSeriesList Source # 
type Rep ProjectsTimeSeriesList = D1 (MetaData "ProjectsTimeSeriesList" "Network.Google.Resource.Monitoring.Projects.TimeSeries.List" "gogol-monitoring-0.1.0-8fG2Jg3yn7LPO0CSB39IU" False) (C1 (MetaCons "ProjectsTimeSeriesList'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptslIntervalStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptslXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptslOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptslPp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_ptslAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslAggregationPerSeriesAligner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptslBearerToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptslName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ptslAggregationGroupByFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslAggregationCrossSeriesReducer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptslFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ptslAggregationAlignmentPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ptslPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslIntervalEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ptslPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) (S1 (MetaSel (Just Symbol "_ptslCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))))
type Scopes ProjectsTimeSeriesList Source # 
type Scopes ProjectsTimeSeriesList = (:) Symbol "https://www.googleapis.com/auth/cloud-platform" ((:) Symbol "https://www.googleapis.com/auth/monitoring" ((:) Symbol "https://www.googleapis.com/auth/monitoring.read" ([] Symbol)))
type Rs ProjectsTimeSeriesList Source # 

Request Lenses

ptslIntervalStartTime :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

If this value is omitted, the interval is a point in time, `endTime`. If `startTime` is present, it must be earlier than (less than) `endTime`. The interval begins after `startTime`—it does not include `startTime`.

ptslUploadProtocol :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

ptslOrderBy :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.

ptslPp :: Lens' ProjectsTimeSeriesList Bool Source #

Pretty-print response.

ptslUploadType :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

ptslAggregationPerSeriesAligner :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.

ptslName :: Lens' ProjectsTimeSeriesList Text Source #

The project on which to execute the request. The format is "projects/{project_id_or_number}".

ptslAggregationGroupByFields :: Lens' ProjectsTimeSeriesList [Text] Source #

The set of fields to preserve when `crossSeriesReducer` is specified. The `groupByFields` determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The `crossSeriesReducer` is applied to each subset of time series. Fields not specified in `groupByFields` are aggregated away. If `groupByFields` is not specified, the time series are aggregated into a single output time series. If `crossSeriesReducer` is not defined, this field is ignored.

ptslView :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

Specifies which information is returned about the time series.

ptslAggregationCrossSeriesReducer :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specified and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error is returned.

ptslFilter :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.label.instance_name = "my-instance-name"

ptslAggregationAlignmentPeriod :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

The alignment period for per-[time series](TimeSeries) alignment. If present, `alignmentPeriod` must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If `perSeriesAligner` is not specified or equals `ALIGN_NONE`, then this field is ignored. If `perSeriesAligner` is specified and does not equal `ALIGN_NONE`, then this field must be defined; otherwise an error is returned.

ptslPageToken :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

If this field is not empty then it must contain the `nextPageToken` value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

ptslIntervalEndTime :: Lens' ProjectsTimeSeriesList (Maybe Text) Source #

Required. The end of the interval. The interval includes this time.

ptslPageSize :: Lens' ProjectsTimeSeriesList (Maybe Int32) Source #

A positive number that is the maximum number of results to return. When `view` field sets to `FULL`, it limits the number of `Points` server will return; if `view` field is `HEADERS`, it limits the number of `TimeSeries` server will return.