Class DateTimeConverter

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

This processor converts a datetime string into a format that you specify.

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

See Also:

  • Method Details

    • source

      public final String source()

      The key to apply the date conversion to.

      Returns:
      The key to apply the date conversion to.

    • target

      public final String target()

      The JSON field to store the result in.

      Returns:
      The JSON field to store the result in.

    • targetFormat

      public final String targetFormat()

      The datetime format to use for the converted data in the target field.

      If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z is used.

      Returns:
      The datetime format to use for the converted data in the target field.

      If you omit this, the default of yyyy-MM-dd'T'HH:mm:ss.SSS'Z is used.

    • hasMatchPatterns

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

    • matchPatterns

      public final List<String> matchPatterns()

      A list of patterns to match against the source field.

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

      Returns:
      A list of patterns to match against the source field.

    • sourceTimezone

      public final String sourceTimezone()

      The time zone of the source field. If you omit this, the default used is the UTC zone.

      Returns:
      The time zone of the source field. If you omit this, the default used is the UTC zone.

    • targetTimezone

      public final String targetTimezone()

      The time zone of the target field. If you omit this, the default used is the UTC zone.

      Returns:
      The time zone of the target field. If you omit this, the default used is the UTC zone.

    • locale

      public final String locale()

      The locale of the source field. If you omit this, the default of locale.ROOT is used.

      Returns:
      The locale of the source field. If you omit this, the default of locale.ROOT is used.

    • toBuilder

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

    • builder

      public static DateTimeConverter.Builder builder()

    • serializableBuilderClass

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