cascading.local.tap.splunk

Class SplunkCSV

java.lang.Object

cascading.scheme.Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,SourceContext,SinkContext>

cascading.scheme.local.CompressorScheme<java.io.LineNumberReader,java.io.PrintWriter>

cascading.scheme.local.TextDelimited

cascading.local.tap.splunk.SplunkCSV

All Implemented Interfaces:

SplunkScheme, cascading.scheme.FileFormat, cascading.util.Traceable, java.io.Serializable

public class SplunkCSV
extends cascading.scheme.local.TextDelimited
implements SplunkScheme

Class SplunkCSV is a Scheme that enables CSV export from a Splunk instance.

Any given declared source Fields will be passed to the underlying export request. By default only the default fields will be retrieved, but will be declared as Fields.UNKNOWN in the final plan.

This Scheme may only be used to source data from Splunk.

Default fields from web service, but not guaranteed

 "_serial"
 "_time" ->  yyyy-MM-dd HH:mm:ss.SSS z
 "source"
 "sourcetype"
 "host"
 "index"
 "splunk_server"
 "_raw"
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class cascading.scheme.local.CompressorScheme

cascading.scheme.local.CompressorScheme.Compressor

Field Summary

Fields

Modifier and Type	Field and Description
static cascading.tuple.Fields	_INDEXTIME
static cascading.tuple.Fields	_RAW
static cascading.tuple.Fields	_SERIAL
static cascading.tuple.Fields	_SUBSECOND
static cascading.tuple.Fields	_TIME
static cascading.tuple.type.DateType	DATE_TYPE
static cascading.tuple.Fields	DEFAULTS Typical default fields emitted from an export if no fields specified.
static cascading.tuple.Fields	HOST
static cascading.tuple.Fields	INDEX
static cascading.tuple.Fields	KNOWN All known internal Splunk fields.
static cascading.tuple.Fields	SOURCE
static cascading.tuple.Fields	SOURCETYPE
static cascading.tuple.Fields	SPLUNK_SERVER
static cascading.tuple.Fields	TIMEENDPOS
static cascading.tuple.Fields	TIMESTARTPOS

Fields inherited from class cascading.scheme.local.TextDelimited

DEFAULT_CHARSET

Fields inherited from class cascading.scheme.local.CompressorScheme

compressor, NO_COMPRESSOR

Constructor Summary

Constructors

Constructor and Description
SplunkCSV() Instantiates a new SplunkCSV instance.
SplunkCSV(cascading.tuple.Fields fields) Instantiates a new SplunkCSV instance that returns the given fields.

Method Summary

Modifier and Type	Method and Description
boolean	isSink()
cascading.tuple.Fields	retrieveSourceFields(cascading.flow.FlowProcess<? extends java.util.Properties> process, cascading.tap.Tap tap)
void	sink(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess, cascading.scheme.SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall)
void	sourceConfInit(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess, cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap, java.util.Properties conf)

Methods inherited from class cascading.scheme.local.TextDelimited

createInput, createOutput, getCharsetName, getDelimiter, getExtension, getQuote, isAppendingFile, isSymmetrical, presentSinkFields, presentSourceFields, setSinkFields, setSourceFields, sinkCleanup, sinkConfInit, sinkPrepare, source, sourceCleanup, sourcePrepare, sourceRePrepare

Methods inherited from class cascading.scheme.local.CompressorScheme

setCompressor, sinkWrap, sourceWrap

Methods inherited from class cascading.scheme.Scheme

equals, getNumSinkParts, getSinkFields, getSourceFields, getTrace, hashCode, isSource, presentSinkFieldsInternal, presentSourceFieldsInternal, retrieveSinkFields, setNumSinkParts, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATE_TYPE

public static final cascading.tuple.type.DateType DATE_TYPE

_TIME

public static final cascading.tuple.Fields _TIME

_SERIAL

public static final cascading.tuple.Fields _SERIAL

SOURCE

public static final cascading.tuple.Fields SOURCE

SOURCETYPE

public static final cascading.tuple.Fields SOURCETYPE

HOST

public static final cascading.tuple.Fields HOST

INDEX

public static final cascading.tuple.Fields INDEX

SPLUNK_SERVER

public static final cascading.tuple.Fields SPLUNK_SERVER

_RAW

public static final cascading.tuple.Fields _RAW

_INDEXTIME

public static final cascading.tuple.Fields _INDEXTIME

_SUBSECOND

public static final cascading.tuple.Fields _SUBSECOND

TIMESTARTPOS

public static final cascading.tuple.Fields TIMESTARTPOS

TIMEENDPOS

public static final cascading.tuple.Fields TIMEENDPOS

DEFAULTS

public static final cascading.tuple.Fields DEFAULTS

Typical default fields emitted from an export if no fields specified.

KNOWN

public static final cascading.tuple.Fields KNOWN

All known internal Splunk fields.

Constructor Detail

SplunkCSV

public SplunkCSV()

Instantiates a new SplunkCSV instance.

SplunkCSV

public SplunkCSV(cascading.tuple.Fields fields)

Instantiates a new SplunkCSV instance that returns the given fields.

Parameters:

fields - the fields

Method Detail

isSink

public boolean isSink()

Overrides:

isSink in class cascading.scheme.Scheme<java.util.Properties,java.io.InputStream,java.io.OutputStream,java.io.LineNumberReader,java.io.PrintWriter>

sink

public void sink(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess,
                 cascading.scheme.SinkCall<java.io.PrintWriter,java.io.OutputStream> sinkCall)

Overrides:

sink in class cascading.scheme.local.TextDelimited

sourceConfInit

public void sourceConfInit(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess,
                           cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream> tap,
                           java.util.Properties conf)

Overrides:

sourceConfInit in class cascading.scheme.local.TextDelimited

retrieveSourceFields

public cascading.tuple.Fields retrieveSourceFields(cascading.flow.FlowProcess<? extends java.util.Properties> process,
                                                   cascading.tap.Tap tap)

Overrides:

retrieveSourceFields in class cascading.scheme.local.TextDelimited