gogol-monitoring-0.0.1: Google Cloud Monitoring SDK.

Copyright(c) 2015 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.Monitoring.Types

Contents

Description

 

Synopsis

Service Configuration

monitoringService :: Service Source

Default request referring to version v2beta2 of the Cloud Monitoring API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

cloudPlatformScope :: OAuthScope Source

View and manage your data across Google Cloud Platform services

monitoringScope :: OAuthScope Source

View and write monitoring data for all of your Google and third-party Cloud and API projects

MetricDescriptorTypeDescriptor

metricDescriptorTypeDescriptor :: MetricDescriptorTypeDescriptor Source

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

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

mdtdMetricType :: Lens' MetricDescriptorTypeDescriptor (Maybe Text) Source

The method of collecting data for the metric. See Metric types.

mdtdValueType :: Lens' MetricDescriptorTypeDescriptor (Maybe Text) Source

The data type of of individual points in the metric's time series. See Metric value types.

ListTimeseriesResponse

listTimeseriesResponse :: ListTimeseriesResponse Source

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

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

ltrNextPageToken :: Lens' ListTimeseriesResponse (Maybe Text) Source

Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set the pageToken query parameter to this value. All of the points of a time series will be returned before returning any point of the subsequent time series.

ltrKind :: Lens' ListTimeseriesResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesResponse".

ltrOldest :: Lens' ListTimeseriesResponse (Maybe UTCTime) Source

The oldest timestamp of the interval of this query as an RFC 3339 string.

ltrYoungest :: Lens' ListTimeseriesResponse (Maybe UTCTime) Source

The youngest timestamp of the interval of this query as an RFC 3339 string.

MetricDescriptor

data MetricDescriptor Source

A metricDescriptor defines the name, label keys, and data type of a particular metric.

See: metricDescriptor smart constructor.

metricDescriptor :: MetricDescriptor Source

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

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

mdProject :: Lens' MetricDescriptor (Maybe Text) Source

The project ID to which the metric belongs.

mdName :: Lens' MetricDescriptor (Maybe Text) Source

The name of this metric.

mdDescription :: Lens' MetricDescriptor (Maybe Text) Source

Description of this metric.

WriteTimeseriesRequest

writeTimeseriesRequest :: WriteTimeseriesRequest Source

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

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

wtrTimeseries :: Lens' WriteTimeseriesRequest [TimeseriesPoint] Source

Provide time series specific labels and the data points for each time series. The labels in timeseries and the common_labels should form a complete list of labels that required by the metric.

WriteTimeseriesRequestCommonLabels

writeTimeseriesRequestCommonLabels Source

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

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

MetricDescriptorLabelDescriptor

metricDescriptorLabelDescriptor :: MetricDescriptorLabelDescriptor Source

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

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

PointDistributionUnderflowBucket

pointDistributionUnderflowBucket :: PointDistributionUnderflowBucket Source

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

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

pdubUpperBound :: Lens' PointDistributionUnderflowBucket (Maybe Double) Source

The upper bound of the value interval of this bucket (exclusive).

pdubCount :: Lens' PointDistributionUnderflowBucket (Maybe Int64) Source

The number of events whose values are in the interval defined by this bucket.

TimeseriesListAggregator

ListMetricDescriptorsResponse

listMetricDescriptorsResponse :: ListMetricDescriptorsResponse Source

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

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

lmdrNextPageToken :: Lens' ListMetricDescriptorsResponse (Maybe Text) Source

Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, pass this value to the pageToken query parameter.

lmdrKind :: Lens' ListMetricDescriptorsResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listMetricDescriptorsResponse".

ListTimeseriesDescriptorsRequest

listTimeseriesDescriptorsRequest :: ListTimeseriesDescriptorsRequest Source

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

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

ltdrKind :: Lens' ListTimeseriesDescriptorsRequest Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsRequest".

TimeseriesDescriptorLabels

timeseriesDescriptorLabels Source

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

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

PointDistributionBucket

data PointDistributionBucket Source

The histogram's bucket. Buckets that form the histogram of a distribution value. If the upper bound of a bucket, say U1, does not equal the lower bound of the next bucket, say L2, this means that there is no event in [U1, L2).

See: pointDistributionBucket smart constructor.

pointDistributionBucket :: PointDistributionBucket Source

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

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

pdbUpperBound :: Lens' PointDistributionBucket (Maybe Double) Source

The upper bound of the value interval of this bucket (exclusive).

pdbCount :: Lens' PointDistributionBucket (Maybe Int64) Source

The number of events whose values are in the interval defined by this bucket.

pdbLowerBound :: Lens' PointDistributionBucket (Maybe Double) Source

The lower bound of the value interval of this bucket (inclusive).

WriteTimeseriesResponse

writeTimeseriesResponse :: WriteTimeseriesResponse Source

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

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

wtrKind :: Lens' WriteTimeseriesResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#writeTimeseriesResponse".

TimeseriesDescriptorLabel

timeseriesDescriptorLabel :: TimeseriesDescriptorLabel Source

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

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

PointDistribution

data PointDistribution Source

Distribution data point value type. When writing distribution points, try to be consistent with the boundaries of your buckets. If you must modify the bucket boundaries, then do so by merging, partitioning, or appending rather than skewing them.

See: pointDistribution smart constructor.

pointDistribution :: PointDistribution Source

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

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

Point

data Point Source

Point is a single point in a time series. It consists of a start time, an end time, and a value.

See: point smart constructor.

point :: Point Source

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

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

pBoolValue :: Lens' Point (Maybe Bool) Source

The value of this data point. Either "true" or "false".

pStart :: Lens' Point (Maybe UTCTime) Source

The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.

pDoubleValue :: Lens' Point (Maybe Double) Source

The value of this data point as a double-precision floating-point number.

pStringValue :: Lens' Point (Maybe Text) Source

The value of this data point in string format.

pDistributionValue :: Lens' Point (Maybe PointDistribution) Source

The value of this data point as a distribution. A distribution value can contain a list of buckets and/or an underflowBucket and an overflowBucket. The values of these points can be used to create a histogram.

pEnd :: Lens' Point (Maybe UTCTime) Source

The interval [start, end] is the time period to which the point's value applies. For gauge metrics, whose values are instantaneous measurements, this interval should be empty (start should equal end). For cumulative metrics (of which deltas and rates are special cases), the interval should be non-empty. Both start and end are RFC 3339 strings.

pInt64Value :: Lens' Point (Maybe Int64) Source

The value of this data point as a 64-bit integer.

PointDistributionOverflowBucket

pointDistributionOverflowBucket :: PointDistributionOverflowBucket Source

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

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

pdobCount :: Lens' PointDistributionOverflowBucket (Maybe Int64) Source

The number of events whose values are in the interval defined by this bucket.

pdobLowerBound :: Lens' PointDistributionOverflowBucket (Maybe Double) Source

The lower bound of the value interval of this bucket (inclusive).

ListTimeseriesDescriptorsResponse

listTimeseriesDescriptorsResponse :: ListTimeseriesDescriptorsResponse Source

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

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

lNextPageToken :: Lens' ListTimeseriesDescriptorsResponse (Maybe Text) Source

Pagination token. If present, indicates that additional results are available for retrieval. To access the results past the pagination limit, set this value to the pageToken query parameter.

lKind :: Lens' ListTimeseriesDescriptorsResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesDescriptorsResponse".

lOldest :: Lens' ListTimeseriesDescriptorsResponse (Maybe UTCTime) Source

The oldest timestamp of the interval of this query, as an RFC 3339 string.

lYoungest :: Lens' ListTimeseriesDescriptorsResponse (Maybe UTCTime) Source

The youngest timestamp of the interval of this query, as an RFC 3339 string.

ListMetricDescriptorsRequest

listMetricDescriptorsRequest :: ListMetricDescriptorsRequest Source

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

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

lisKind :: Lens' ListMetricDescriptorsRequest Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listMetricDescriptorsRequest".

TimeseriesPoint

data TimeseriesPoint Source

When writing time series, TimeseriesPoint should be used instead of Timeseries, to enforce single point for each time series in the timeseries.write request.

See: timeseriesPoint smart constructor.

timeseriesPoint :: TimeseriesPoint Source

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

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

tpPoint :: Lens' TimeseriesPoint (Maybe Point) Source

The data point in this time series snapshot.

tpTimeseriesDesc :: Lens' TimeseriesPoint (Maybe TimeseriesDescriptor) Source

The descriptor of this time series.

TimeseriesDescriptorsListAggregator

DeleteMetricDescriptorResponse

deleteMetricDescriptorResponse :: DeleteMetricDescriptorResponse Source

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

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

dmdrKind :: Lens' DeleteMetricDescriptorResponse Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#deleteMetricDescriptorResponse".

ListTimeseriesRequest

listTimeseriesRequest :: ListTimeseriesRequest Source

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

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

ltrtKind :: Lens' ListTimeseriesRequest Text Source

Identifies what kind of resource this is. Value: the fixed string "cloudmonitoring#listTimeseriesRequest".

TimeseriesDescriptor

timeseriesDescriptor :: TimeseriesDescriptor Source

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

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

tdProject :: Lens' TimeseriesDescriptor (Maybe Text) Source

The Developers Console project number to which this time series belongs.

tdMetric :: Lens' TimeseriesDescriptor (Maybe Text) Source

The name of the metric.

Timeseries

data Timeseries Source

The monitoring data is organized as metrics and stored as data points that are recorded over time. Each data point represents information like the CPU utilization of your virtual machine. A historical record of these data points is called a time series.

See: timeseries smart constructor.

timeseries :: Timeseries Source

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

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

tPoints :: Lens' Timeseries [Point] Source

The data points of this time series. The points are listed in order of their end timestamp, from younger to older.

tTimeseriesDesc :: Lens' Timeseries (Maybe TimeseriesDescriptor) Source

The descriptor of this time series.