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

Interface MetricFilter.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MetricFilter.Builder,MetricFilter>, SdkBuilder<MetricFilter.Builder,MetricFilter>, SdkPojo

Enclosing class:

MetricFilter

@Mutable
@NotThreadSafe
public static interface MetricFilter.Builder
extends SdkPojo, CopyableBuilder<MetricFilter.Builder,MetricFilter>

Method Summary

Modifier and Type	Method	Description
MetricFilter.Builder	applyOnTransformedLogs(Boolean applyOnTransformedLogs)	This parameter is valid only for log groups that have an active log transformer.
MetricFilter.Builder	creationTime(Long creationTime)	The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
MetricFilter.Builder	emitSystemFieldDimensions(String... emitSystemFieldDimensions)	The list of system fields that are emitted as additional dimensions in the generated metrics.
MetricFilter.Builder	emitSystemFieldDimensions(Collection<String> emitSystemFieldDimensions)	The list of system fields that are emitted as additional dimensions in the generated metrics.
MetricFilter.Builder	fieldSelectionCriteria(String fieldSelectionCriteria)	The filter expression that specifies which log events are processed by this metric filter based on system fields.
MetricFilter.Builder	filterName(String filterName)	The name of the metric filter.
MetricFilter.Builder	filterPattern(String filterPattern)	Sets the value of the FilterPattern property for this object.
MetricFilter.Builder	logGroupName(String logGroupName)	The name of the log group.
MetricFilter.Builder	metricTransformations(Collection<MetricTransformation> metricTransformations)	The metric transformations.
MetricFilter.Builder	metricTransformations(Consumer<MetricTransformation.Builder>... metricTransformations)	The metric transformations.
MetricFilter.Builder	metricTransformations(MetricTransformation... metricTransformations)	The metric transformations.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

filterName

MetricFilter.Builder filterName(String filterName)

The name of the metric filter.

Parameters:

filterName - The name of the metric filter.

Returns:

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

filterPattern

MetricFilter.Builder filterPattern(String filterPattern)

Sets the value of the FilterPattern property for this object.

Parameters:

filterPattern - The new value for the FilterPattern property for this object.

Returns:

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

metricTransformations

MetricFilter.Builder metricTransformations(Collection<MetricTransformation> metricTransformations)

The metric transformations.

Parameters:

metricTransformations - The metric transformations.

Returns:

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

metricTransformations

MetricFilter.Builder metricTransformations(MetricTransformation... metricTransformations)

The metric transformations.

Parameters:

metricTransformations - The metric transformations.

Returns:

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

metricTransformations

MetricFilter.Builder metricTransformations(Consumer<MetricTransformation.Builder>... metricTransformations)

The metric transformations.

This is a convenience method that creates an instance of the MetricTransformation.Builder avoiding the need to create one manually via MetricTransformation.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metricTransformations(List).

Parameters:

metricTransformations - a consumer that will call methods on MetricTransformation.Builder

Returns:

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

See Also:

#metricTransformations(java.util.Collection)

creationTime

MetricFilter.Builder creationTime(Long creationTime)

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

Parameters:

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

Returns:

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

logGroupName

MetricFilter.Builder logGroupName(String logGroupName)

The name of the log group.

Parameters:

logGroupName - The name of the log group.

Returns:

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

applyOnTransformedLogs

MetricFilter.Builder applyOnTransformedLogs(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.

Parameters:

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:

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

fieldSelectionCriteria

MetricFilter.Builder fieldSelectionCriteria(String fieldSelectionCriteria)

The filter expression that specifies which log events are processed by this metric filter based on system fields. Returns the fieldSelectionCriteria value if it was specified when the metric filter was created.

Parameters:

fieldSelectionCriteria - The filter expression that specifies which log events are processed by this metric filter based on system fields. Returns the fieldSelectionCriteria value if it was specified when the metric filter was created.

Returns:

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

emitSystemFieldDimensions

MetricFilter.Builder emitSystemFieldDimensions(Collection<String> emitSystemFieldDimensions)

The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

Parameters:

emitSystemFieldDimensions - The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

Returns:

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

emitSystemFieldDimensions

MetricFilter.Builder emitSystemFieldDimensions(String... emitSystemFieldDimensions)

The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

Parameters:

emitSystemFieldDimensions - The list of system fields that are emitted as additional dimensions in the generated metrics. Returns the emitSystemFieldDimensions value if it was specified when the metric filter was created.

Returns:

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