Package com.oracle.bmc.logging.model

Class UnifiedAgentParserFilter

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.logging.model.UnifiedAgentLoggingFilter

com.oracle.bmc.logging.model.UnifiedAgentParserFilter

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200531")
public final class UnifiedAgentParserFilter
extends UnifiedAgentLoggingFilter

Logging parser filter object.

Ref: https://docs.fluentd.org/filter/parser
Note: Objects should always be created or deserialized using the UnifiedAgentParserFilter.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the UnifiedAgentParserFilter.Builder, which maintain a set of all explicitly set fields called UnifiedAgentParserFilter.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UnifiedAgentParserFilter.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.logging.model.UnifiedAgentLoggingFilter

UnifiedAgentLoggingFilter.FilterType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
UnifiedAgentParserFilter(String name, UnifiedAgentParser parser, String keyName, Boolean reserveTime, Boolean reserveData, Boolean removeKeyNameField, Boolean replaceInvalidSequence, String injectKeyPrefix, String hashValueField, Boolean emitInvalidRecordToError)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static UnifiedAgentParserFilter.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getEmitInvalidRecordToError()	If true, emit invalid record to @ERROR label.
String	getHashValueField()	Store the parsed values as a hash value in a field.
String	getInjectKeyPrefix()	Store the parsed values with the specified key name prefix.
String	getKeyName()	The field name in the record to parse.
UnifiedAgentParser	getParser()
Boolean	getRemoveKeyNameField()	If true, remove the keyName field when parsing is succeeded.
Boolean	getReplaceInvalidSequence()	If true, the invalid string is replaced with safe characters and is re-parsed.
Boolean	getReserveData()	If true, keep the original key-value pair in the parsed result.
Boolean	getReserveTime()	If true, keep the original event time in the parsed result.
int	hashCode()
UnifiedAgentParserFilter.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.logging.model.UnifiedAgentLoggingFilter

getName

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

UnifiedAgentParserFilter

@Deprecated
public UnifiedAgentParserFilter(String name,
                                UnifiedAgentParser parser,
                                String keyName,
                                Boolean reserveTime,
                                Boolean reserveData,
                                Boolean removeKeyNameField,
                                Boolean replaceInvalidSequence,
                                String injectKeyPrefix,
                                String hashValueField,
                                Boolean emitInvalidRecordToError)

Deprecated.

Method Detail

builder

public static UnifiedAgentParserFilter.Builder builder()

Create a new builder.

toBuilder

public UnifiedAgentParserFilter.Builder toBuilder()

getParser

public UnifiedAgentParser getParser()

getKeyName

public String getKeyName()

The field name in the record to parse.

Returns:

the value

getReserveTime

public Boolean getReserveTime()

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

Returns:

the value

getReserveData

public Boolean getReserveData()

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

Returns:

the value

getRemoveKeyNameField

public Boolean getRemoveKeyNameField()

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

Returns:

the value

getReplaceInvalidSequence

public Boolean getReplaceInvalidSequence()

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

Returns:

the value

getInjectKeyPrefix

public String getInjectKeyPrefix()

Store the parsed values with the specified key name prefix.

Returns:

the value

getHashValueField

public String getHashValueField()

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

Returns:

the value

getEmitInvalidRecordToError

public Boolean getEmitInvalidRecordToError()

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.

Returns:

the value

toString

public String toString()

Overrides:

toString in class UnifiedAgentLoggingFilter

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class UnifiedAgentLoggingFilter

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class UnifiedAgentLoggingFilter

hashCode

public int hashCode()

Overrides:

hashCode in class UnifiedAgentLoggingFilter