com.amazonaws.services.cloudwatch.model

Class ListMetricsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudwatch.model.ListMetricsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListMetricsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListMetricsRequest()

Method Summary

Modifier and Type	Method and Description
ListMetricsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<DimensionFilter>	getDimensions() The dimensions to filter against.
Boolean	getIncludeLinkedAccounts() If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
String	getMetricName() The name of the metric to filter against.
String	getNamespace() The metric namespace to filter against.
String	getNextToken() The token returned by a previous call to indicate that there is more data available.
String	getOwningAccount() When you use this operation in a monitoring account, use this field to return metrics only from one source account.
String	getRecentlyActive() To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H.
int	hashCode()
Boolean	isIncludeLinkedAccounts() If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
void	setDimensions(Collection<DimensionFilter> dimensions) The dimensions to filter against.
void	setIncludeLinkedAccounts(Boolean includeLinkedAccounts) If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
void	setMetricName(String metricName) The name of the metric to filter against.
void	setNamespace(String namespace) The metric namespace to filter against.
void	setNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
void	setOwningAccount(String owningAccount) When you use this operation in a monitoring account, use this field to return metrics only from one source account.
void	setRecentlyActive(String recentlyActive) To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H.
String	toString() Returns a string representation of this object.
ListMetricsRequest	withDimensions(Collection<DimensionFilter> dimensions) The dimensions to filter against.
ListMetricsRequest	withDimensions(DimensionFilter... dimensions) The dimensions to filter against.
ListMetricsRequest	withIncludeLinkedAccounts(Boolean includeLinkedAccounts) If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.
ListMetricsRequest	withMetricName(String metricName) The name of the metric to filter against.
ListMetricsRequest	withNamespace(String namespace) The metric namespace to filter against.
ListMetricsRequest	withNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
ListMetricsRequest	withOwningAccount(String owningAccount) When you use this operation in a monitoring account, use this field to return metrics only from one source account.
ListMetricsRequest	withRecentlyActive(RecentlyActive recentlyActive) To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H.
ListMetricsRequest	withRecentlyActive(String recentlyActive) To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMetricsRequest

public ListMetricsRequest()

Method Detail

setNamespace

public void setNamespace(String namespace)

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Parameters:

namespace - The metric namespace to filter against. Only the namespace that matches exactly will be returned.

getNamespace

public String getNamespace()

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Returns:

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

withNamespace

public ListMetricsRequest withNamespace(String namespace)

The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Parameters:

namespace - The metric namespace to filter against. Only the namespace that matches exactly will be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMetricName

public void setMetricName(String metricName)

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Parameters:

metricName - The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

getMetricName

public String getMetricName()

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Returns:

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

withMetricName

public ListMetricsRequest withMetricName(String metricName)

The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Parameters:

metricName - The name of the metric to filter against. Only the metrics with names that match exactly will be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDimensions

public List<DimensionFilter> getDimensions()

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Returns:

The dimensions to filter against. Only the dimensions that match exactly will be returned.

setDimensions

public void setDimensions(Collection<DimensionFilter> dimensions)

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Parameters:

dimensions - The dimensions to filter against. Only the dimensions that match exactly will be returned.

withDimensions

public ListMetricsRequest withDimensions(DimensionFilter... dimensions)

The dimensions to filter against. Only the dimensions that match exactly will be returned.

NOTE: This method appends the values to the existing list (if any). Use setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to override the existing values.

Parameters:

dimensions - The dimensions to filter against. Only the dimensions that match exactly will be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

withDimensions

public ListMetricsRequest withDimensions(Collection<DimensionFilter> dimensions)

The dimensions to filter against. Only the dimensions that match exactly will be returned.

Parameters:

dimensions - The dimensions to filter against. Only the dimensions that match exactly will be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

getNextToken

public String getNextToken()

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

Returns:

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

withNextToken

public ListMetricsRequest withNextToken(String nextToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRecentlyActive

public void setRecentlyActive(String recentlyActive)

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Parameters:

recentlyActive - To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

See Also:

RecentlyActive

getRecentlyActive

public String getRecentlyActive()

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Returns:

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

See Also:

RecentlyActive

withRecentlyActive

public ListMetricsRequest withRecentlyActive(String recentlyActive)

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Parameters:

recentlyActive - To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RecentlyActive

withRecentlyActive

public ListMetricsRequest withRecentlyActive(RecentlyActive recentlyActive)

To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Parameters:

recentlyActive - To filter the results to show only metrics that have had data points published in the past three hours, specify this parameter with a value of PT3H. This is the only valid value for this parameter.

The results that are returned are an approximation of the value you specify. There is a low probability that the returned results include metrics with last published data as much as 40 minutes more than the specified time interval.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RecentlyActive

setIncludeLinkedAccounts

public void setIncludeLinkedAccounts(Boolean includeLinkedAccounts)

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Parameters:

includeLinkedAccounts - If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

getIncludeLinkedAccounts

public Boolean getIncludeLinkedAccounts()

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Returns:

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

withIncludeLinkedAccounts

public ListMetricsRequest withIncludeLinkedAccounts(Boolean includeLinkedAccounts)

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Parameters:

includeLinkedAccounts - If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Returns:

Returns a reference to this object so that method calls can be chained together.

isIncludeLinkedAccounts

public Boolean isIncludeLinkedAccounts()

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

Returns:

If you are using this operation in a monitoring account, specify true to include metrics from source accounts in the returned data.

The default is false.

setOwningAccount

public void setOwningAccount(String owningAccount)

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

Parameters:

owningAccount - When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

getOwningAccount

public String getOwningAccount()

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

Returns:

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

withOwningAccount

public ListMetricsRequest withOwningAccount(String owningAccount)

When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

Parameters:

owningAccount - When you use this operation in a monitoring account, use this field to return metrics only from one source account. To do so, specify that source account ID in this field, and also specify true for IncludeLinkedAccounts.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListMetricsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()