Package org.opennms.netmgt.syslogd

Enum GrokParserStageSequenceBuilder.SyslogSemanticType

java.lang.Object

java.lang.Enum<GrokParserStageSequenceBuilder.SyslogSemanticType>

org.opennms.netmgt.syslogd.GrokParserStageSequenceBuilder.SyslogSemanticType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GrokParserStageSequenceBuilder.SyslogSemanticType>

Enclosing class:

GrokParserStageSequenceBuilder

public static enum GrokParserStageSequenceBuilder.SyslogSemanticType
extends java.lang.Enum<GrokParserStageSequenceBuilder.SyslogSemanticType>

This enum contains all well-known syslog message fields.

Enum Constant Summary

Enum Constants

Enum Constant	Description
day	2-digit day of month (1-31).
facilityPriority	Facility-priority integer.
hostname	String hostname (unqualified or FQDN), IPv4 address, or IPv6 address.
hour	2-digit hour of day (0-23).
message	Remaining string message.
messageId	String message ID.
minute	2-digit minute (0-59).
month	2-digit month (1-12).
processId	String process name.
processName	String process name.
second	2-digit second (0-59).
secondFraction	1- to 6-digit fractional second value as a string.
timezone	String timezone value.
version	Version.
year	4-digit year.

Method Summary

Modifier and Type	Method	Description
static GrokParserStageSequenceBuilder.SyslogSemanticType	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static GrokParserStageSequenceBuilder.SyslogSemanticType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

facilityPriority

public static final GrokParserStageSequenceBuilder.SyslogSemanticType facilityPriority

Facility-priority integer.

See Also:

3164: PRI, 5424: PRIVAL

version

public static final GrokParserStageSequenceBuilder.SyslogSemanticType version

Version.

See Also:

5424: VERSION

year

public static final GrokParserStageSequenceBuilder.SyslogSemanticType year

4-digit year.

See Also:

3339, 5424: DATE-FULLYEAR

month

public static final GrokParserStageSequenceBuilder.SyslogSemanticType month

2-digit month (1-12).

See Also:

3164, 3339, 5424: DATE-MONTH

day

public static final GrokParserStageSequenceBuilder.SyslogSemanticType day

2-digit day of month (1-31).

See Also:

3164, 3339, 5424: DATE-MDAY

hour

public static final GrokParserStageSequenceBuilder.SyslogSemanticType hour

2-digit hour of day (0-23).

See Also:

3164, 3339, 5424: TIME-HOUR

minute

public static final GrokParserStageSequenceBuilder.SyslogSemanticType minute

2-digit minute (0-59).

See Also:

3164, 3339, 5424: TIME-MINUTE

second

public static final GrokParserStageSequenceBuilder.SyslogSemanticType second

2-digit second (0-59).

See Also:

3164, 3339, 5424: TIME-SECOND

secondFraction

public static final GrokParserStageSequenceBuilder.SyslogSemanticType secondFraction

1- to 6-digit fractional second value as a string. Note that the maximum resolution of this value is microseconds but we are storing the value in nanoseconds since nanosecond resolution is more prevalent in the Java time APIs.

See Also:

5424: TIME-SECFRAC

timezone

public static final GrokParserStageSequenceBuilder.SyslogSemanticType timezone

String timezone value.

See Also:

3339, 5424: TIME-OFFSET

hostname

public static final GrokParserStageSequenceBuilder.SyslogSemanticType hostname

String hostname (unqualified or FQDN), IPv4 address, or IPv6 address.

See Also:

5424: HOSTNAME

processName

public static final GrokParserStageSequenceBuilder.SyslogSemanticType processName

String process name.

See Also:

5424: APP-NAME

processId

public static final GrokParserStageSequenceBuilder.SyslogSemanticType processId

String process name.

See Also:

5424: PROCID

messageId

public static final GrokParserStageSequenceBuilder.SyslogSemanticType messageId

String message ID.

See Also:

5424: MSGID

message

public static final GrokParserStageSequenceBuilder.SyslogSemanticType message

Remaining string message.

Method Detail

values

public static GrokParserStageSequenceBuilder.SyslogSemanticType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GrokParserStageSequenceBuilder.SyslogSemanticType c : GrokParserStageSequenceBuilder.SyslogSemanticType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GrokParserStageSequenceBuilder.SyslogSemanticType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null