cascading.local.tap.splunk

Class SplunkIndexTap

java.lang.Object

cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

cascading.local.tap.splunk.SplunkTap

cascading.local.tap.splunk.SplunkIndexTap

All Implemented Interfaces:

cascading.flow.FlowElement, cascading.flow.planner.ScopedElement, cascading.util.Traceable, java.io.Serializable

public class SplunkIndexTap
extends SplunkTap

Class SplunkIndexTap can return all the results from a given index or write to the index.

It is currently assumed the index name given is not a pattern/wildcard.

In order to source (only) from a search result, see SplunkSearchTap.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SplunkIndexTap(SplunkScheme scheme, com.splunk.ServiceArgs serviceArgs, com.splunk.JobExportArgs exportArgs, cascading.tap.SinkMode sinkMode, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, com.splunk.ServiceArgs serviceArgs, com.splunk.JobExportArgs exportArgs, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, com.splunk.ServiceArgs serviceArgs, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, com.splunk.Service service, com.splunk.JobExportArgs exportArgs, cascading.tap.SinkMode sinkMode, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, com.splunk.Service service, com.splunk.JobExportArgs exportArgs, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, com.splunk.Service service, java.lang.String indexName)
SplunkIndexTap(SplunkScheme scheme, java.lang.String host, int port, java.lang.String indexName)

Method Summary

Modifier and Type	Method and Description
boolean	createResource(java.util.Properties conf)
boolean	deleteResource(java.util.Properties conf)
protected com.splunk.Index	getIndex()
long	getModifiedTime(java.util.Properties conf)
protected com.splunk.Index	getOrCreateIndex()
protected java.lang.String	getSearch()
protected java.lang.String	getSplunkPath()
protected java.lang.String	getSplunkQuery()
cascading.tuple.TupleEntryCollector	openForWrite(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess, java.io.OutputStream outputStream)
boolean	resourceExists(java.util.Properties conf)

Methods inherited from class cascading.local.tap.splunk.SplunkTap

getIdentifier, getService, openForRead

Methods inherited from class cascading.tap.Tap

commitResource, createResource, deleteResource, entryStream, entryStream, entryStreamCopy, entryStreamCopy, equals, flowConfInit, getConfigDef, getFullIdentifier, getFullIdentifier, getModifiedTime, getNodeConfigDef, getScheme, getSinkFields, getSinkMode, getSourceFields, getStepConfigDef, getTrace, hasConfigDef, hashCode, hasNodeConfigDef, hasStepConfigDef, id, isKeep, isReplace, isSink, isSource, isTemporary, isUpdate, openForRead, openForReadUnchecked, openForWrite, outgoingScopeFor, prepareResourceForRead, prepareResourceForWrite, presentSinkFields, presentSourceFields, resolveIncomingOperationArgumentFields, resolveIncomingOperationPassThroughFields, resourceExists, retrieveSinkFields, retrieveSourceFields, rollbackResource, setScheme, sinkConfInit, sourceConfInit, spliterator, splititerator, taps, toString, tupleStream, tupleStream, tupleStreamCopy, tupleStreamCopy

Methods inherited from class java.lang.Object

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

Constructor Detail

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      java.lang.String host,
                      int port,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.ServiceArgs serviceArgs,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.ServiceArgs serviceArgs,
                      com.splunk.JobExportArgs exportArgs,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.ServiceArgs serviceArgs,
                      com.splunk.JobExportArgs exportArgs,
                      cascading.tap.SinkMode sinkMode,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.Service service,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.Service service,
                      com.splunk.JobExportArgs exportArgs,
                      java.lang.String indexName)

SplunkIndexTap

public SplunkIndexTap(SplunkScheme scheme,
                      com.splunk.Service service,
                      com.splunk.JobExportArgs exportArgs,
                      cascading.tap.SinkMode sinkMode,
                      java.lang.String indexName)

Method Detail

getSplunkQuery

protected java.lang.String getSplunkQuery()

Specified by:

getSplunkQuery in class SplunkTap

getSplunkPath

protected java.lang.String getSplunkPath()

Specified by:

getSplunkPath in class SplunkTap

getSearch

protected java.lang.String getSearch()

Specified by:

getSearch in class SplunkTap

openForWrite

public cascading.tuple.TupleEntryCollector openForWrite(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess,
                                                        java.io.OutputStream outputStream)
                                                 throws java.io.IOException

Specified by:

openForWrite in class cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

Throws:

java.io.IOException

getOrCreateIndex

protected com.splunk.Index getOrCreateIndex()

getIndex

protected com.splunk.Index getIndex()

createResource

public boolean createResource(java.util.Properties conf)

Specified by:

createResource in class cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

deleteResource

public boolean deleteResource(java.util.Properties conf)

Specified by:

deleteResource in class cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

resourceExists

public boolean resourceExists(java.util.Properties conf)
                       throws java.io.IOException

Specified by:

resourceExists in class cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

Throws:

java.io.IOException

getModifiedTime

public long getModifiedTime(java.util.Properties conf)
                     throws java.io.IOException

Specified by:

getModifiedTime in class cascading.tap.Tap<java.util.Properties,java.io.InputStream,java.io.OutputStream>

Throws:

java.io.IOException