Package software.amazon.awssdk.services.cloudwatchlogs.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DateTimeConverter.Builder

Method Summary

Modifier and Type	Method	Description
static DateTimeConverter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchPatterns()	For responses, this returns true if the service returned a value for the MatchPatterns property.
String	locale()	The locale of the source field.
List<String>	matchPatterns()	A list of patterns to match against the source field.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DateTimeConverter.Builder>	serializableBuilderClass()
String	source()	The key to apply the date conversion to.
String	sourceTimezone()	The time zone of the source field.
String	target()	The JSON field to store the result in.
String	targetFormat()	The datetime format to use for the converted data in the target field.
String	targetTimezone()	The time zone of the target field.
DateTimeConverter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<DateTimeConverter.Builder,DateTimeConverter>

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)

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)

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