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

Class ParseToOCSF

java.lang.Object

software.amazon.awssdk.services.cloudwatchlogs.model.ParseToOCSF

All Implemented Interfaces:

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

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

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParseToOCSF.Builder

Method Summary

Modifier and Type	Method	Description
static ParseToOCSF.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EventSource	eventSource()	Specify the service or process that produces the log events that will be converted with this processor.
String	eventSourceAsString()	Specify the service or process that produces the log events that will be converted with this processor.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	mappingVersion()	The version of the OCSF mapping to use for parsing log data.
OCSFVersion	ocsfVersion()	Specify which version of the OCSF schema to use for the transformed log events.
String	ocsfVersionAsString()	Specify which version of the OCSF schema to use for the transformed log events.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ParseToOCSF.Builder>	serializableBuilderClass()
String	source()	The path to the field in the log event that you want to parse.
ParseToOCSF.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.

eventSource

public final EventSource eventSource()

Specify the service or process that produces the log events that will be converted with this processor.

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

Returns:

Specify the service or process that produces the log events that will be converted with this processor.

See Also:

EventSource

eventSourceAsString

public final String eventSourceAsString()

Specify the service or process that produces the log events that will be converted with this processor.

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

Returns:

Specify the service or process that produces the log events that will be converted with this processor.

See Also:

EventSource

ocsfVersion

public final OCSFVersion ocsfVersion()

Specify which version of the OCSF schema to use for the transformed log events.

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

Returns:

Specify which version of the OCSF schema to use for the transformed log events.

See Also:

OCSFVersion

ocsfVersionAsString

public final String ocsfVersionAsString()

Specify which version of the OCSF schema to use for the transformed log events.

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

Returns:

Specify which version of the OCSF schema to use for the transformed log events.

See Also:

OCSFVersion

mappingVersion

public final String mappingVersion()

The version of the OCSF mapping to use for parsing log data.

Returns:

The version of the OCSF mapping to use for parsing log data.

toBuilder

public ParseToOCSF.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParseToOCSF.Builder,ParseToOCSF>

builder

public static ParseToOCSF.Builder builder()

serializableBuilderClass

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