com.amazonaws.services.logs.model

Class DescribeMetricFiltersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.DescribeMetricFiltersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeMetricFiltersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeMetricFilters operation.

Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name.

By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a nextToken value in the response body. You can also limit the number of metric filters returned in the response by specifying the limit parameter in the request.

See Also:

AWSLogs.describeMetricFilters(DescribeMetricFiltersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeMetricFiltersRequest() Default constructor for a new DescribeMetricFiltersRequest object.
DescribeMetricFiltersRequest(String logGroupName) Constructs a new DescribeMetricFiltersRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeMetricFiltersRequest	clone()
boolean	equals(Object obj)
String	getFilterNamePrefix() Will only return metric filters that match the provided filterNamePrefix.
Integer	getLimit() The maximum number of items returned in the response.
String	getLogGroupName() The log group name for which metric filters are to be listed.
String	getNextToken() A string token used for pagination that points to the next page of results.
int	hashCode()
void	setFilterNamePrefix(String filterNamePrefix) Will only return metric filters that match the provided filterNamePrefix.
void	setLimit(Integer limit) The maximum number of items returned in the response.
void	setLogGroupName(String logGroupName) The log group name for which metric filters are to be listed.
void	setNextToken(String nextToken) A string token used for pagination that points to the next page of results.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeMetricFiltersRequest	withFilterNamePrefix(String filterNamePrefix) Will only return metric filters that match the provided filterNamePrefix.
DescribeMetricFiltersRequest	withLimit(Integer limit) The maximum number of items returned in the response.
DescribeMetricFiltersRequest	withLogGroupName(String logGroupName) The log group name for which metric filters are to be listed.
DescribeMetricFiltersRequest	withNextToken(String nextToken) A string token used for pagination that points to the next page of results.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeMetricFiltersRequest

public DescribeMetricFiltersRequest()

Default constructor for a new DescribeMetricFiltersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeMetricFiltersRequest

public DescribeMetricFiltersRequest(String logGroupName)

Constructs a new DescribeMetricFiltersRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

logGroupName - The log group name for which metric filters are to be listed.

Method Detail

getLogGroupName

public String getLogGroupName()

The log group name for which metric filters are to be listed.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

The log group name for which metric filters are to be listed.

setLogGroupName

public void setLogGroupName(String logGroupName)

The log group name for which metric filters are to be listed.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The log group name for which metric filters are to be listed.

withLogGroupName

public DescribeMetricFiltersRequest withLogGroupName(String logGroupName)

The log group name for which metric filters are to be listed.

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

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The log group name for which metric filters are to be listed.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilterNamePrefix

public String getFilterNamePrefix()

Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Returns:

Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

setFilterNamePrefix

public void setFilterNamePrefix(String filterNamePrefix)

Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

filterNamePrefix - Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

withFilterNamePrefix

public DescribeMetricFiltersRequest withFilterNamePrefix(String filterNamePrefix)

Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

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

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

filterNamePrefix - Will only return metric filters that match the provided filterNamePrefix. If you don't specify a value, no prefix filter is applied.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

Constraints:
Length: 1 -

Returns:

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

setNextToken

public void setNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

withNextToken

public DescribeMetricFiltersRequest withNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

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

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous DescribeMetricFilters request.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Returns:

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

setLimit

public void setLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

withLimit

public DescribeMetricFiltersRequest withLimit(Integer limit)

The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

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

Constraints:
Range: 1 - 50

Parameters:

limit - The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeMetricFiltersRequest clone()

Overrides:

clone in class AmazonWebServiceRequest