com.amazonaws.services.logs.model

Class PutMetricFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutMetricFilterRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutMetricFilterRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutMetricFilter operation.

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents requests.

The maximum number of metric filters that can be associated with a log group is 100.

See Also:

AWSLogs.putMetricFilter(PutMetricFilterRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutMetricFilterRequest() Default constructor for a new PutMetricFilterRequest object.
PutMetricFilterRequest(String logGroupName, String filterName, String filterPattern, List<MetricTransformation> metricTransformations) Constructs a new PutMetricFilterRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
PutMetricFilterRequest	clone()
boolean	equals(Object obj)
String	getFilterName() A name for the metric filter.
String	getFilterPattern() A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
String	getLogGroupName() The name of the log group to associate the metric filter with.
List<MetricTransformation>	getMetricTransformations() A collection of information needed to define how metric data gets emitted.
int	hashCode()
void	setFilterName(String filterName) A name for the metric filter.
void	setFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
void	setLogGroupName(String logGroupName) The name of the log group to associate the metric filter with.
void	setMetricTransformations(Collection<MetricTransformation> metricTransformations) A collection of information needed to define how metric data gets emitted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutMetricFilterRequest	withFilterName(String filterName) A name for the metric filter.
PutMetricFilterRequest	withFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.
PutMetricFilterRequest	withLogGroupName(String logGroupName) The name of the log group to associate the metric filter with.
PutMetricFilterRequest	withMetricTransformations(Collection<MetricTransformation> metricTransformations) A collection of information needed to define how metric data gets emitted.
PutMetricFilterRequest	withMetricTransformations(MetricTransformation... metricTransformations) A collection of information needed to define how metric data gets emitted.

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

PutMetricFilterRequest

public PutMetricFilterRequest()

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

PutMetricFilterRequest

public PutMetricFilterRequest(String logGroupName,
                      String filterName,
                      String filterPattern,
                      List<MetricTransformation> metricTransformations)

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

Parameters:

logGroupName - The name of the log group to associate the metric filter with.

filterName - A name for the metric filter.

filterPattern - A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

metricTransformations - A collection of information needed to define how metric data gets emitted.

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to associate the metric filter with.

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

Returns:

The name of the log group to associate the metric filter with.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to associate the metric filter with.

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

Parameters:

logGroupName - The name of the log group to associate the metric filter with.

withLogGroupName

public PutMetricFilterRequest withLogGroupName(String logGroupName)

The name of the log group to associate the metric filter with.

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 name of the log group to associate the metric filter with.

Returns:

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

getFilterName

public String getFilterName()

A name for the metric filter.

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

Returns:

A name for the metric filter.

setFilterName

public void setFilterName(String filterName)

A name for the metric filter.

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

Parameters:

filterName - A name for the metric filter.

withFilterName

public PutMetricFilterRequest withFilterName(String filterName)

A name for the metric filter.

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

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

Parameters:

filterName - A name for the metric filter.

Returns:

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

getFilterPattern

public String getFilterPattern()

A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

Constraints:
Length: 0 - 512

Returns:

A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

setFilterPattern

public void setFilterPattern(String filterPattern)

A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

withFilterPattern

public PutMetricFilterRequest withFilterPattern(String filterPattern)

A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

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

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A valid CloudWatch Logs filter pattern for extracting metric data out of ingested log events.

Returns:

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

getMetricTransformations

public List<MetricTransformation> getMetricTransformations()

A collection of information needed to define how metric data gets emitted.

Constraints:
Length: 1 - 1

Returns:

A collection of information needed to define how metric data gets emitted.

setMetricTransformations

public void setMetricTransformations(Collection<MetricTransformation> metricTransformations)

A collection of information needed to define how metric data gets emitted.

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - A collection of information needed to define how metric data gets emitted.

withMetricTransformations

public PutMetricFilterRequest withMetricTransformations(MetricTransformation... metricTransformations)

A collection of information needed to define how metric data gets emitted.

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

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

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - A collection of information needed to define how metric data gets emitted.

Returns:

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

withMetricTransformations

public PutMetricFilterRequest withMetricTransformations(Collection<MetricTransformation> metricTransformations)

A collection of information needed to define how metric data gets emitted.

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

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - A collection of information needed to define how metric data gets emitted.

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 PutMetricFilterRequest clone()

Overrides:

clone in class AmazonWebServiceRequest