gogol-monitoring-0.4.0: Google Stackdriver 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: Stackdriver Monitoring API Reference for monitoring.projects.timeSeries.list.

Synopsis

REST Resource

type ProjectsTimeSeriesListResource = "v3" :> (Capture "name" Text :> ("timeSeries" :> (QueryParam "interval.startTime" DateTime' :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "orderBy" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "aggregation.perSeriesAligner" Text :> (QueryParams "aggregation.groupByFields" Text :> (QueryParam "view" Text :> (QueryParam "aggregation.crossSeriesReducer" Text :> (QueryParam "filter" Text :> (QueryParam "aggregation.alignmentPeriod" GDuration :> (QueryParam "pageToken" Text :> (QueryParam "interval.endTime" DateTime' :> (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 # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

Data ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

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 # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

Generic ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

Associated Types

type Rep ProjectsTimeSeriesList :: Type -> Type #

GoogleRequest ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

type Rep ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

type Rep ProjectsTimeSeriesList = D1 (MetaData "ProjectsTimeSeriesList" "Network.Google.Resource.Monitoring.Projects.TimeSeries.List" "gogol-monitoring-0.4.0-2c26UZAXxP5IDqve62RFQh" False) (C1 (MetaCons "ProjectsTimeSeriesList'" PrefixI True) ((((S1 (MetaSel (Just "_ptslIntervalStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_ptslXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv))) :*: (S1 (MetaSel (Just "_ptslUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ptslOrderBy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ptslAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ptslUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ptslAggregationPerSeriesAligner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ptslName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :*: (((S1 (MetaSel (Just "_ptslAggregationGroupByFields") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_ptslView") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ptslAggregationCrossSeriesReducer") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ptslFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_ptslAggregationAlignmentPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GDuration)) :*: S1 (MetaSel (Just "_ptslPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_ptslIntervalEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: (S1 (MetaSel (Just "_ptslPageSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_ptslCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Scopes ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

type Scopes ProjectsTimeSeriesList = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/monitoring" ': ("https://www.googleapis.com/auth/monitoring.read" ': ([] :: [Symbol])))
type Rs ProjectsTimeSeriesList Source # 
Instance details

Defined in Network.Google.Resource.Monitoring.Projects.TimeSeries.List

Request Lenses

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

Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.

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

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

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

Unsupported: must be left blank. The points in each time series are returned in reverse time order.

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. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then 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 Scientific) Source #

The alignment period for per-time series 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 UTCTime) Source #

Required. The end of the time interval.

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

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.