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

Interface PutMetricFilterRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>, SdkBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutMetricFilterRequest
@Mutable @NotThreadSafe public static interface PutMetricFilterRequest.Builder extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<PutMetricFilterRequest.Builder,PutMetricFilterRequest>

  • Method Details

    • logGroupName

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

    • filterName

      PutMetricFilterRequest.Builder filterName(String filterName)

      A name for the metric filter.

      Parameters:
      filterName - A name for the metric filter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filterPattern

      PutMetricFilterRequest.Builder filterPattern(String filterPattern)

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

      Parameters:
      filterPattern - A filter pattern for extracting metric data out of ingested log events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricTransformations

      PutMetricFilterRequest.Builder metricTransformations(Collection<MetricTransformation> metricTransformations)

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

      Parameters:
      metricTransformations - A collection of information that defines how metric data gets emitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricTransformations

      PutMetricFilterRequest.Builder metricTransformations(MetricTransformation... metricTransformations)

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

      Parameters:
      metricTransformations - A collection of information that defines how metric data gets emitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricTransformations

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

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

      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<MetricTransformation>).

      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:

    • applyOnTransformedLogs

      PutMetricFilterRequest.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 the log group uses either a log-group level or account-level transformer, and you specify true, the metric filter will be 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 the log group uses either a log-group level or account-level transformer, and you specify true, the metric filter will be 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

      PutMetricFilterRequest.Builder fieldSelectionCriteria(String fieldSelectionCriteria)

      A filter expression that specifies which log events should be processed by this metric filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region = "us-east-1" or @aws.account IN ["123456789012", "987654321098"]. Maximum length: 2000 characters.

      Parameters:
      fieldSelectionCriteria - A filter expression that specifies which log events should be processed by this metric filter based on system fields such as source account and source region. Uses selection criteria syntax with operators like =, !=, AND, OR, IN, NOT IN. Example: @aws.region = "us-east-1" or @aws.account IN ["123456789012", "987654321098"]. Maximum length: 2000 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emitSystemFieldDimensions

      PutMetricFilterRequest.Builder emitSystemFieldDimensions(Collection<String> emitSystemFieldDimensions)

      A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account and @aws.region. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.

      Parameters:
      emitSystemFieldDimensions - A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account and @aws.region. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • emitSystemFieldDimensions

      PutMetricFilterRequest.Builder emitSystemFieldDimensions(String... emitSystemFieldDimensions)

      A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account and @aws.region. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.

      Parameters:
      emitSystemFieldDimensions - A list of system fields to emit as additional dimensions in the generated metrics. Valid values are @aws.account and @aws.region. These dimensions help identify the source of centralized log data and count toward the total dimension limit for metric filters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutMetricFilterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      PutMetricFilterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder