com.amazonaws.services.logs.model

Class PutMetricFilterRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutMetricFilterRequest

All Implemented Interfaces:

Serializable

public class PutMetricFilterRequest
extends AmazonWebServiceRequest
implements Serializable

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.

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
boolean	equals(Object obj)
String	getFilterName() The name of the metric filter.
String	getFilterPattern() A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry.
String	getLogGroupName() Returns the value of the LogGroupName property for this object.
List<MetricTransformation>	getMetricTransformations() Returns the value of the MetricTransformations property for this object.
int	hashCode()
void	setFilterName(String filterName) The name of the metric filter.
void	setFilterPattern(String filterPattern) A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry.
void	setLogGroupName(String logGroupName) Sets the value of the LogGroupName property for this object.
void	setMetricTransformations(Collection<MetricTransformation> metricTransformations) Sets the value of the MetricTransformations property for this object.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutMetricFilterRequest	withFilterName(String filterName) The name of the metric filter.
PutMetricFilterRequest	withFilterPattern(String filterPattern) A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry.
PutMetricFilterRequest	withLogGroupName(String logGroupName) Sets the value of the LogGroupName property for this object.
PutMetricFilterRequest	withMetricTransformations(Collection<MetricTransformation> metricTransformations) Sets the value of the MetricTransformations property for this object.
PutMetricFilterRequest	withMetricTransformations(MetricTransformation... metricTransformations) Sets the value of the MetricTransformations property for this object.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

clone, 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 -

filterName - The name of the metric filter.

filterPattern - A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

metricTransformations -

Method Detail

getLogGroupName

public String getLogGroupName()

Returns the value of the LogGroupName property for this object.

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

Returns:

The value of the LogGroupName property for this object.

setLogGroupName

public void setLogGroupName(String logGroupName)

Sets the value of the LogGroupName property for this object.

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

Parameters:

logGroupName - The new value for the LogGroupName property for this object.

withLogGroupName

public PutMetricFilterRequest withLogGroupName(String logGroupName)

Sets the value of the LogGroupName property for this object.

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 new value for the LogGroupName property for this object.

Returns:

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

getFilterName

public String getFilterName()

The name of the metric filter.

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

Returns:

The name of the metric filter.

setFilterName

public void setFilterName(String filterName)

The name of the metric filter.

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

Parameters:

filterName - The name of the metric filter.

withFilterName

public PutMetricFilterRequest withFilterName(String filterName)

The name of the metric filter.

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

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

Parameters:

filterName - The name of the metric filter.

Returns:

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

getFilterPattern

public String getFilterPattern()

A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

Constraints:
Length: 0 - 512

Returns:

A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

setFilterPattern

public void setFilterPattern(String filterPattern)

A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

withFilterPattern

public PutMetricFilterRequest withFilterPattern(String filterPattern)

A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

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

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log entry. For example, a log entry may contain timestamps, IP addresses, strings, and so on. You use the pattern to specify what to look for in the log stream.

Returns:

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

getMetricTransformations

public List<MetricTransformation> getMetricTransformations()

Returns the value of the MetricTransformations property for this object.

Constraints:
Length: 1 - 1

Returns:

The value of the MetricTransformations property for this object.

setMetricTransformations

public void setMetricTransformations(Collection<MetricTransformation> metricTransformations)

Sets the value of the MetricTransformations property for this object.

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - The new value for the MetricTransformations property for this object.

withMetricTransformations

public PutMetricFilterRequest withMetricTransformations(MetricTransformation... metricTransformations)

Sets the value of the MetricTransformations property for this object.

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

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - The new value for the MetricTransformations property for this object.

Returns:

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

withMetricTransformations

public PutMetricFilterRequest withMetricTransformations(Collection<MetricTransformation> metricTransformations)

Sets the value of the MetricTransformations property for this object.

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

Constraints:
Length: 1 - 1

Parameters:

metricTransformations - The new value for the MetricTransformations property for this object.

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