Class ListToMap

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

This processor takes a list of objects that contain key fields, and converts them into a map of target keys.

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

See Also:

  • Method Details

    • source

      public final String source()

      The key in the log event that has a list of objects that will be converted to a map.

      Returns:
      The key in the log event that has a list of objects that will be converted to a map.

    • key

      public final String key()

      The key of the field to be extracted as keys in the generated map

      Returns:
      The key of the field to be extracted as keys in the generated map

    • valueKey

      public final String valueKey()

      If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map. Otherwise, original objects in the source list will be put into the values of the generated map.

      Returns:
      If this is specified, the values that you specify in this parameter will be extracted from the source objects and put into the values of the generated map. Otherwise, original objects in the source list will be put into the values of the generated map.

    • target

      public final String target()

      The key of the field that will hold the generated map

      Returns:
      The key of the field that will hold the generated map

    • flatten

      public final Boolean flatten()

      A Boolean value to indicate whether the list will be flattened into single items. Specify true to flatten the list. The default is false

      Returns:
      A Boolean value to indicate whether the list will be flattened into single items. Specify true to flatten the list. The default is false

    • flattenedElement

      public final FlattenedElement flattenedElement()

      If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

      You must specify this parameter if flatten is true

      If the service returns an enum value that is not available in the current SDK version, flattenedElement will return FlattenedElement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flattenedElementAsString().

      Returns:
      If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

      You must specify this parameter if flatten is true

      See Also:

    • flattenedElementAsString

      public final String flattenedElementAsString()

      If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

      You must specify this parameter if flatten is true

      If the service returns an enum value that is not available in the current SDK version, flattenedElement will return FlattenedElement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from flattenedElementAsString().

      Returns:
      If you set flatten to true, use flattenedElement to specify which element, first or last, to keep.

      You must specify this parameter if flatten is true

      See Also:

    • toBuilder

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

    • builder

      public static ListToMap.Builder builder()

    • serializableBuilderClass

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