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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParseKeyValue.Builder

Method Summary

Modifier and Type	Method	Description
static ParseKeyValue.Builder	builder()
String	destination()	The destination field to put the extracted key-value pairs into
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fieldDelimiter()	The field delimiter string that is used between key-value pairs in the original log events.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyPrefix()	If you want to add a prefix to all transformed keys, specify it here.
String	keyValueDelimiter()	The delimiter string to use between the key and value in each pair in the transformed log event.
String	nonMatchValue()	A value to insert into the value field in the result, when a key-value pair is not successfully split.
Boolean	overwriteIfExists()	Specifies whether to overwrite the value if the destination key already exists.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ParseKeyValue.Builder>	serializableBuilderClass()
String	source()	Path to the field in the log event that will be parsed.
ParseKeyValue.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()

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

Specified by:

toBuilder in interface ToCopyableBuilder<ParseKeyValue.Builder,ParseKeyValue>

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)

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