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

Class Grok

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.Grok

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Grok.Builder,Grok>

@Generated("software.amazon.awssdk:codegen")
public final class Grok
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Grok.Builder,Grok>

This processor uses pattern matching to parse and structure unstructured data. This processor can also extract fields from log messages.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Grok.Builder

Method Summary

Modifier and Type	Method	Description
static Grok.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	match()	The grok pattern to match against the log event.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Grok.Builder>	serializableBuilderClass()
String	source()	The path to the field in the log event that you want to parse.
Grok.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 path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.

Returns:

The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.

match

public final String match()

The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.

Returns:

The grok pattern to match against the log event. For a list of supported grok patterns, see Supported grok patterns.

toBuilder

public Grok.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Grok.Builder,Grok>

builder

public static Grok.Builder builder()

serializableBuilderClass

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