Copyright (c) 2015-2016 Brendan Hay Mozilla Public License, v. 2.0. Brendan Hay auto-generated non-portable (GHC extensions) None Haskell2010

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 "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" Duration :> (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

Arguments

 :: Text ptslName -> ProjectsTimeSeriesList

Creates a value of ProjectsTimeSeriesList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ptslIntervalStartTime
• ptslXgafv
• ptslUploadProtocol
• ptslOrderBy
• ptslPp
• ptslAccessToken
• ptslUploadType
• ptslAggregationPerSeriesAligner
• ptslBearerToken
• ptslName
• ptslAggregationGroupByFields
• ptslView
• ptslAggregationCrossSeriesReducer
• ptslFilter
• ptslAggregationAlignmentPeriod
• ptslPageToken
• ptslIntervalEndTime
• ptslPageSize
• ptslCallback

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

See: projectsTimeSeriesList smart constructor.

Instances

# Request Lenses

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.

V1 error format.

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

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.

Pretty-print response.

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

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.

OAuth bearer token.

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

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.

Specifies which information is returned about the time series.

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.

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"

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.

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.

Required. The end of the time interval.

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.

JSONP