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

Class PutMetricFilterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutMetricFilterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutMetricFilterRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutMetricFilterRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutMetricFilterRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	filterName()	A name for the metric filter.
String	filterPattern()	A filter pattern for extracting metric data out of ingested log events.
<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()	A collection of information that defines how metric data gets emitted.
List<SdkField<?>>	sdkFields()
static Class<? extends PutMetricFilterRequest.Builder>	serializableBuilderClass()
PutMetricFilterRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

filterName

public final String filterName()

A name for the metric filter.

Returns:

A name for the metric filter.

filterPattern

public final String filterPattern()

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

Returns:

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

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

A collection of information that defines how metric data gets emitted.

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:

A collection of information that defines how metric data gets emitted.

toBuilder

public PutMetricFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutMetricFilterRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo