Package software.amazon.awssdk.services.cloudwatchlogs.model

Class MetricFilter

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.MetricFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricFilter.Builder,MetricFilter>

@Generated("software.amazon.awssdk:codegen")
public final class MetricFilter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetricFilter.Builder,MetricFilter>

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricFilter.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	applyOnTransformedLogs()	This parameter is valid only for log groups that have an active log transformer.
static MetricFilter.Builder	builder()
Long	creationTime()	The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterName()	The name of the metric filter.
String	filterPattern()	Returns the value of the FilterPattern property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricTransformations()	For responses, this returns true if the service returned a value for the MetricTransformations property.
String	logGroupName()	The name of the log group.
List<MetricTransformation>	metricTransformations()	The metric transformations.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends MetricFilter.Builder>	serializableBuilderClass()
MetricFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

filterName

public final String filterName()

The name of the metric filter.

Returns:

The name of the metric filter.

filterPattern

public final String filterPattern()

Returns the value of the FilterPattern property for this object.

Returns:

The value of the FilterPattern property for this object.

hasMetricTransformations

public final boolean hasMetricTransformations()

For responses, this returns true if the service returned a value for the MetricTransformations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricTransformations

public final List<MetricTransformation> metricTransformations()

The metric transformations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricTransformations() method.

Returns:

The metric transformations.

creationTime

public final Long creationTime()

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Returns:

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

applyOnTransformedLogs

public final Boolean applyOnTransformedLogs()

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

If this value is true, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

Returns:

This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see PutTransformer.

If this value is true, the metric filter is applied on the transformed version of the log events instead of the original ingested log events.

toBuilder

public MetricFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricFilter.Builder,MetricFilter>

builder

public static MetricFilter.Builder builder()

serializableBuilderClass

public static Class<? extends MetricFilter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo