org.jclouds.cloudwatch.features

Interface MetricApi

public interface MetricApi

Provides access to Amazon CloudWatch via the Query API

Author:

Jeremy Whitlock

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
GetMetricStatisticsResponse	getMetricStatistics(GetMetricStatistics statistics)
GetMetricStatisticsResponse	getMetricStatistics(GetMetricStatistics statistics, GetMetricStatisticsOptions options) Gets statistics for the specified metric.
PagedIterable<Metric>	list()
IterableWithMarker<Metric>	list(ListMetricsOptions options) Returns a list of valid metrics stored for the AWS account owner.
void	putMetricsInNamespace(Iterable<MetricDatum> metrics, String namespace) Publishes metric data points to Amazon CloudWatch.

Method Detail

list

@Named(value="ListMetrics")
IterableWithMarker<Metric> list(ListMetricsOptions options)

Returns a list of valid metrics stored for the AWS account owner.

Note

Up to 500 results are returned for any one call. To retrieve further results, use returned NextToken ( ListMetricsResponse.getNextToken()) value with subsequent calls .To retrieve all available metrics with one call, use CloudWatch.listMetrics(MetricApi, org.jclouds.cloudwatch.options.ListMetricsOptions)

Parameters:

options - the options describing the metrics query

Returns:

the response object

list

@Named(value="ListMetrics")
PagedIterable<Metric> list()

getMetricStatistics

@Named(value="GetMetricStatistics")
GetMetricStatisticsResponse getMetricStatistics(GetMetricStatistics statistics,
                                                    GetMetricStatisticsOptions options)

Gets statistics for the specified metric.

Parameters:

statistics - the statistics to gather

options - the options describing the metric statistics query

Returns:

the response object

getMetricStatistics

@Named(value="GetMetricStatistics")
GetMetricStatisticsResponse getMetricStatistics(GetMetricStatistics statistics)

putMetricsInNamespace

@Named(value="PutMetricData")
void putMetricsInNamespace(Iterable<MetricDatum> metrics,
                               String namespace)

Publishes metric data points to Amazon CloudWatch.

Parameters:

metrics - the metrics to publish

namespace - the namespace to publish the metrics to