Package org.jclouds.cloudwatch.features

Interface MetricApi

public interface MetricApi

Provides access to Amazon CloudWatch via the Query API

See Also:

Method Summary

Modifier and Type	Method	Description
GetMetricStatisticsResponse	getMetricStatistics(GetMetricStatistics statistics)
GetMetricStatisticsResponse	getMetricStatistics(GetMetricStatistics statistics, GetMetricStatisticsOptions options)	Gets statistics for the specified metric.
org.jclouds.collect.PagedIterable<Metric>	list()
org.jclouds.collect.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("ListMetrics")
@POST
@Path("/")
org.jclouds.collect.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("ListMetrics")
@POST
@Path("/")
org.jclouds.collect.PagedIterable<Metric> list()

getMetricStatistics

@Named("GetMetricStatistics")
@POST
@Path("/")
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("GetMetricStatistics")
@POST
@Path("/")
GetMetricStatisticsResponse getMetricStatistics(GetMetricStatistics statistics)

putMetricsInNamespace

@Named("PutMetricData")
@POST
@Path("/")
void putMetricsInNamespace(Iterable<MetricDatum> metrics,
                           @FormParam("Namespace")
                           String namespace)

Publishes metric data points to Amazon CloudWatch.

Parameters:

metrics - the metrics to publish

namespace - the namespace to publish the metrics to