Class ParseJSON

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

This processor parses log events that are in JSON format. It can extract JSON key-value pairs and place them under a destination that you specify.

Additionally, because you must have at least one parse-type processor in a transformer, you can use ParseJSON as that processor for JSON-format logs, so that you can also apply other processors, such as mutate processors, to these logs.

For more information about this processor including examples, see parseJSON 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 location to put the parsed key value pair into. If you omit this parameter, it is placed under the root node.

      Returns:
      The location to put the parsed key value pair into. If you omit this parameter, it is placed under the root node.

    • toBuilder

      public ParseJSON.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<ParseJSON.Builder,ParseJSON>
      Returns:
      a builder for type T

    • builder

      public static ParseJSON.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ParseJSON.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.