Merge pull request #623 from jcscoobyrs/master

Issue 922: Add missing javadoc to CloudWatch.listMetrics(MetricClient, ListMetricsOption).
This commit is contained in:
Adrian Cole 2012-05-10 01:33:32 -07:00
commit 8163b6ee64
1 changed files with 9 additions and 1 deletions

View File

@ -33,6 +33,14 @@ import java.util.Iterator;
*/ */
public class CloudWatch { public class CloudWatch {
/**
* List metrics based on the criteria in the {@link ListMetricsOptions} passed in.
*
* @param metricClient the {@link MetricClient} to use for the request
* @param options the {@link ListMetricsOptions} describing the ListMetrics request
*
* @return iterable of metrics fitting the criteria
*/
public static Iterable<Metric> listMetrics(final MetricClient metricClient, final ListMetricsOptions options) { public static Iterable<Metric> listMetrics(final MetricClient metricClient, final ListMetricsOptions options) {
return new Iterable<Metric>() { return new Iterable<Metric>() {
public Iterator<Metric> iterator() { public Iterator<Metric> iterator() {
@ -76,7 +84,7 @@ public class CloudWatch {
/** /**
* List metrics based on the criteria in the {@link ListMetricsOptions} passed in. * List metrics based on the criteria in the {@link ListMetricsOptions} passed in.
* *
* @param cloudWatchClient the CloudWatch client * @param cloudWatchClient the {@link CloudWatchClient} to use for the request
* @param region the region to list metrics in * @param region the region to list metrics in
* @param options the options describing the ListMetrics request * @param options the options describing the ListMetrics request
* *