org.jclouds.cloudwatch.options

Class ListMetricsOptions

java.lang.Object

org.jclouds.http.options.BaseHttpRequestOptions

org.jclouds.cloudwatch.options.ListMetricsOptions

All Implemented Interfaces:

Cloneable, HttpRequestOptions

public class ListMetricsOptions
extends BaseHttpRequestOptions
implements Cloneable

Options used to list available metrics.

Author:

Jeremy Whitlock

See Also:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListMetricsOptions.Builder

Field Summary

Fields inherited from class org.jclouds.http.options.BaseHttpRequestOptions

formParameters, headers, pathSuffix, payload, queryParameters

Constructor Summary

Constructors

Constructor and Description
ListMetricsOptions()

Method Summary

Methods

Modifier and Type	Method and Description
ListMetricsOptions	afterMarker(Object afterMarker) The token returned by a previous call to indicate that there is more data available.
com.google.common.collect.Multimap<String,String>	buildFormParameters() Returns a newly-created ListMetricsOptions based on the contents of the Builder.
ListMetricsOptions	clone()
ListMetricsOptions	dimension(Dimension dimension) A dimension to filter the available metrics by.
ListMetricsOptions	dimensions(Iterable<Dimension> dimensions) A list of dimensions to filter against.
ListMetricsOptions	metricName(String metricName) The name of the metric to filter against.
ListMetricsOptions	namespace(String namespace) The namespace to filter against.

Methods inherited from class org.jclouds.http.options.BaseHttpRequestOptions

buildPathSuffix, buildQueryParameters, buildRequestHeaders, buildStringPayload, equals, getFirstFormOrNull, getFirstHeaderOrNull, getFirstQueryOrNull, hashCode, replaceHeader, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMetricsOptions

public ListMetricsOptions()

Method Detail

namespace

public ListMetricsOptions namespace(String namespace)

The namespace to filter against.

Parameters:

namespace - the namespace to filter against

Returns:

this Builder object

metricName

public ListMetricsOptions metricName(String metricName)

The name of the metric to filter against.

Parameters:

metricName - the metric name to filter against

Returns:

this Builder object

dimensions

public ListMetricsOptions dimensions(Iterable<Dimension> dimensions)

A list of dimensions to filter against.

Parameters:

dimensions - the dimensions to filter against

Returns:

this Builder object

dimension

public ListMetricsOptions dimension(Dimension dimension)

A dimension to filter the available metrics by.

Parameters:

dimension - a dimension to filter the returned metrics by

Returns:

this Builder object

afterMarker

public ListMetricsOptions afterMarker(Object afterMarker)

The token returned by a previous call to indicate that there is more data available.

Parameters:

afterMarker - the next token indicating that there is more data available

Returns:

this Builder object

buildFormParameters

public com.google.common.collect.Multimap<String,String> buildFormParameters()

Returns a newly-created ListMetricsOptions based on the contents of the Builder.

Specified by:

buildFormParameters in interface HttpRequestOptions

Overrides:

buildFormParameters in class BaseHttpRequestOptions

Returns:

map that may contain query parameters.

clone

public ListMetricsOptions clone()

Overrides:

clone in class Object