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>

  • Method Details

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

    • 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 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:
      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.

    • fieldSelectionCriteria

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

      Returns:
      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.

    • hasEmitSystemFieldDimensions

      public final boolean hasEmitSystemFieldDimensions()
      For responses, this returns true if the service returned a value for the EmitSystemFieldDimensions 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.

    • emitSystemFieldDimensions

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

      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 hasEmitSystemFieldDimensions() method.

      Returns:
      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.

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo