com.amazonaws.services.logs.model

Class MetricFilter

java.lang.Object

com.amazonaws.services.logs.model.MetricFilter

All Implemented Interfaces:

Serializable, Cloneable

public class MetricFilter
extends Object
implements Serializable, Cloneable

Metric filters can be used to express how Amazon CloudWatch Logs would extract metric observations from ingested log events and transform them to metric data in a CloudWatch metric.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetricFilter()

Method Summary

Methods

Modifier and Type	Method and Description
MetricFilter	clone()
boolean	equals(Object obj)
Long	getCreationTime() A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
String	getFilterName() A name for a metric or subscription filter.
String	getFilterPattern() A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log event.
List<MetricTransformation>	getMetricTransformations() Returns the value of the MetricTransformations property for this object.
int	hashCode()
void	setCreationTime(Long creationTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
void	setFilterName(String filterName) A name for a metric or subscription filter.
void	setFilterPattern(String filterPattern) A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log event.
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.
MetricFilter	withCreationTime(Long creationTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
MetricFilter	withFilterName(String filterName) A name for a metric or subscription filter.
MetricFilter	withFilterPattern(String filterPattern) A symbolic description of how Amazon CloudWatch Logs should interpret the data in each log event.
MetricFilter	withMetricTransformations(Collection<MetricTransformation> metricTransformations) Sets the value of the MetricTransformations property for this object.
MetricFilter	withMetricTransformations(MetricTransformation... metricTransformations) Sets the value of the MetricTransformations property for this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricFilter

public MetricFilter()

Method Detail

getFilterName

public String getFilterName()

A name for a metric or subscription filter.

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

Returns:

A name for a metric or subscription filter.

setFilterName

public void setFilterName(String filterName)

A name for a metric or subscription filter.

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

Parameters:

filterName - A name for a metric or subscription filter.

withFilterName

public MetricFilter withFilterName(String filterName)

A name for a metric or subscription 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 a metric or subscription 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 event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

Constraints:
Length: 0 - 512

Returns:

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

setFilterPattern

public void setFilterPattern(String filterPattern)

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

Constraints:
Length: 0 - 512

Parameters:

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

withFilterPattern

public MetricFilter withFilterPattern(String filterPattern)

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

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 event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

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 MetricFilter withMetricTransformations(MetricTransformation... metricTransformations)

Sets the value of the MetricTransformations property for this object.

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 - 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 MetricFilter 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.

getCreationTime

public Long getCreationTime()

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Returns:

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

setCreationTime

public void setCreationTime(Long creationTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Parameters:

creationTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

withCreationTime

public MetricFilter withCreationTime(Long creationTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

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

Constraints:
Range: 0 -

Parameters:

creationTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

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

Overrides:

clone in class Object