Class ParseKeyValue

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.ParseKeyValue
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ParseKeyValue.Builder,ParseKeyValue>
@Generated("software.amazon.awssdk:codegen") public final class ParseKeyValue extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ParseKeyValue.Builder,ParseKeyValue>

This processor parses a specified field in the original log event into key-value pairs.

For more information about this processor including examples, see parseKeyValue in the CloudWatch Logs User Guide.

See Also:

  • Method Details

    • source

      public final String source()

      Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book

      Returns:
      Path to the field in the log event that will be parsed. Use dot notation to access child fields. For example, store.book

    • destination

      public final String destination()

      The destination field to put the extracted key-value pairs into

      Returns:
      The destination field to put the extracted key-value pairs into

    • fieldDelimiter

      public final String fieldDelimiter()

      The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.

      Returns:
      The field delimiter string that is used between key-value pairs in the original log events. If you omit this, the ampersand & character is used.

    • keyValueDelimiter

      public final String keyValueDelimiter()

      The delimiter string to use between the key and value in each pair in the transformed log event.

      If you omit this, the equal = character is used.

      Returns:
      The delimiter string to use between the key and value in each pair in the transformed log event.

      If you omit this, the equal = character is used.

    • keyPrefix

      public final String keyPrefix()

      If you want to add a prefix to all transformed keys, specify it here.

      Returns:
      If you want to add a prefix to all transformed keys, specify it here.

    • nonMatchValue

      public final String nonMatchValue()

      A value to insert into the value field in the result, when a key-value pair is not successfully split.

      Returns:
      A value to insert into the value field in the result, when a key-value pair is not successfully split.

    • overwriteIfExists

      public final Boolean overwriteIfExists()

      Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.

      Returns:
      Specifies whether to overwrite the value if the destination key already exists. If you omit this, the default is false.

    • toBuilder

      public ParseKeyValue.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ParseKeyValue.Builder,ParseKeyValue>
      Returns:
      a builder for type T

    • builder

      public static ParseKeyValue.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParseKeyValue.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.