org.apache.drill.exec.store.splunk

Enum SplunkUtils.SPECIAL_FIELDS

java.lang.Object

java.lang.Enum<SplunkUtils.SPECIAL_FIELDS>

org.apache.drill.exec.store.splunk.SplunkUtils.SPECIAL_FIELDS

All Implemented Interfaces:

Serializable, Comparable<SplunkUtils.SPECIAL_FIELDS>

Enclosing class:

SplunkUtils

public static enum SplunkUtils.SPECIAL_FIELDS
extends Enum<SplunkUtils.SPECIAL_FIELDS>

These are special fields that alter the queries sent to Splunk.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EARLIEST_TIME The earliest time boundary of a query, overwrites config variable
LATEST_TIME The latest time bound of a query, overwrites config variable
SOURCETYPE The sourcetype of a query.
SPL Used to send raw SPL to Splunk

Field Summary

Fields

Modifier and Type	Field and Description
String	field

Method Summary

Modifier and Type	Method and Description
static boolean	includes(String field) Indicates whether the field in question is a special field and should be pushed down to the query or not.
static SplunkUtils.SPECIAL_FIELDS	valueOf(String name) Returns the enum constant of this type with the specified name.
static SplunkUtils.SPECIAL_FIELDS[]	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

SOURCETYPE

public static final SplunkUtils.SPECIAL_FIELDS SOURCETYPE

The sourcetype of a query. Specifying the sourcetype can improve query performance.

SPL

public static final SplunkUtils.SPECIAL_FIELDS SPL

Used to send raw SPL to Splunk

EARLIEST_TIME

public static final SplunkUtils.SPECIAL_FIELDS EARLIEST_TIME

The earliest time boundary of a query, overwrites config variable

LATEST_TIME

public static final SplunkUtils.SPECIAL_FIELDS LATEST_TIME

The latest time bound of a query, overwrites config variable

Field Detail

field

public final String field

Method Detail

values

public static SplunkUtils.SPECIAL_FIELDS[] 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 (SplunkUtils.SPECIAL_FIELDS c : SplunkUtils.SPECIAL_FIELDS.values())
    System.out.println(c);

Returns:

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

valueOf

public static SplunkUtils.SPECIAL_FIELDS valueOf(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:

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

NullPointerException - if the argument is null

includes

public static boolean includes(String field)

Indicates whether the field in question is a special field and should be pushed down to the query or not.

Parameters:

unknownField - The field to be pushed down

Returns:

true if the field is a special field, false if not.