Package com.oracle.bmc.logging.model

Class UnifiedAgentParserFilter.Builder

java.lang.Object

com.oracle.bmc.logging.model.UnifiedAgentParserFilter.Builder

Enclosing class:

UnifiedAgentParserFilter

public static class UnifiedAgentParserFilter.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UnifiedAgentParserFilter	build()
UnifiedAgentParserFilter.Builder	copy(UnifiedAgentParserFilter model)
UnifiedAgentParserFilter.Builder	emitInvalidRecordToError(Boolean emitInvalidRecordToError)	If true, emit invalid record to @ERROR label.
UnifiedAgentParserFilter.Builder	hashValueField(String hashValueField)	Store the parsed values as a hash value in a field.
UnifiedAgentParserFilter.Builder	injectKeyPrefix(String injectKeyPrefix)	Store the parsed values with the specified key name prefix.
UnifiedAgentParserFilter.Builder	keyName(String keyName)	The field name in the record to parse.
UnifiedAgentParserFilter.Builder	name(String name)
UnifiedAgentParserFilter.Builder	parser(UnifiedAgentParser parser)
UnifiedAgentParserFilter.Builder	removeKeyNameField(Boolean removeKeyNameField)	If true, remove the keyName field when parsing is succeeded.
UnifiedAgentParserFilter.Builder	replaceInvalidSequence(Boolean replaceInvalidSequence)	If true, the invalid string is replaced with safe characters and is re-parsed.
UnifiedAgentParserFilter.Builder	reserveData(Boolean reserveData)	If true, keep the original key-value pair in the parsed result.
UnifiedAgentParserFilter.Builder	reserveTime(Boolean reserveTime)	If true, keep the original event time in the parsed result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

name

public UnifiedAgentParserFilter.Builder name(String name)

parser

public UnifiedAgentParserFilter.Builder parser(UnifiedAgentParser parser)

keyName

public UnifiedAgentParserFilter.Builder keyName(String keyName)

The field name in the record to parse.

Parameters:

keyName - the value to set

Returns:

this builder

reserveTime

public UnifiedAgentParserFilter.Builder reserveTime(Boolean reserveTime)

If true, keep the original event time in the parsed result.

Parameters:

reserveTime - the value to set

Returns:

this builder

reserveData

public UnifiedAgentParserFilter.Builder reserveData(Boolean reserveData)

If true, keep the original key-value pair in the parsed result.

Parameters:

reserveData - the value to set

Returns:

this builder

removeKeyNameField

public UnifiedAgentParserFilter.Builder removeKeyNameField(Boolean removeKeyNameField)

If true, remove the keyName field when parsing is succeeded.

Parameters:

removeKeyNameField - the value to set

Returns:

this builder

replaceInvalidSequence

public UnifiedAgentParserFilter.Builder replaceInvalidSequence(Boolean replaceInvalidSequence)

If true, the invalid string is replaced with safe characters and is re-parsed.

Parameters:

replaceInvalidSequence - the value to set

Returns:

this builder

injectKeyPrefix

public UnifiedAgentParserFilter.Builder injectKeyPrefix(String injectKeyPrefix)

Store the parsed values with the specified key name prefix.

Parameters:

injectKeyPrefix - the value to set

Returns:

this builder

hashValueField

public UnifiedAgentParserFilter.Builder hashValueField(String hashValueField)

Store the parsed values as a hash value in a field.

Parameters:

hashValueField - the value to set

Returns:

this builder

emitInvalidRecordToError

public UnifiedAgentParserFilter.Builder emitInvalidRecordToError(Boolean emitInvalidRecordToError)

If true, emit invalid record to @ERROR label.

Invalid cases are: 1) key does not exist; 2) the format does not match; or 3) an unexpected error. You can rescue unexpected format logs in the @ERROR lable. If you want to ignore these errors, set this to false.

Parameters:

emitInvalidRecordToError - the value to set

Returns:

this builder

build

public UnifiedAgentParserFilter build()

copy

public UnifiedAgentParserFilter.Builder copy(UnifiedAgentParserFilter model)