cascading.local.tap.splunk

Class SplunkSearchTap

java.lang.Object

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

cascading.local.tap.splunk.SplunkTap

cascading.local.tap.splunk.SplunkSearchTap

All Implemented Interfaces:

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

public class SplunkSearchTap
extends SplunkTap

Class SplunkSearchTap can return all the results from a given search query.

This Tap cannot be used to sink data into a Splunk cluster, see SplunkIndexTap.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SplunkSearchTap(SplunkScheme scheme, com.splunk.ServiceArgs serviceArgs, com.splunk.JobExportArgs exportArgs, java.lang.String search) Instantiates a new SplunkSearchTap.
SplunkSearchTap(SplunkScheme scheme, com.splunk.ServiceArgs serviceArgs, java.lang.String search) Instantiates a new SplunkSearchTap.
SplunkSearchTap(SplunkScheme scheme, com.splunk.Service service, java.lang.String search) Instantiates a new SplunkSearchTap.
SplunkSearchTap(SplunkScheme scheme, java.lang.String host, int port, java.lang.String search) Instantiates a new SplunkSearchTap.

Method Summary

Modifier and Type	Method and Description
boolean	commitResource(java.util.Properties conf)
boolean	createResource(java.util.Properties conf)
boolean	deleteResource(java.util.Properties conf)
long	getModifiedTime(java.util.Properties conf)
protected java.lang.String	getSearch()
cascading.tuple.Fields	getSinkFields()
protected java.lang.String	getSplunkPath()
protected java.lang.String	getSplunkQuery()
boolean	isSink()
cascading.tuple.TupleEntryCollector	openForWrite(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess, java.io.OutputStream output)
boolean	prepareResourceForWrite(java.util.Properties conf)
boolean	resourceExists(java.util.Properties conf)
boolean	rollbackResource(java.util.Properties conf)
void	sinkConfInit(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess, java.util.Properties conf)

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

getIdentifier, getService, openForRead

Methods inherited from class cascading.tap.Tap

createResource, deleteResource, entryStream, entryStream, entryStreamCopy, entryStreamCopy, equals, flowConfInit, getConfigDef, getFullIdentifier, getFullIdentifier, getModifiedTime, getNodeConfigDef, getScheme, getSinkMode, getSourceFields, getStepConfigDef, getTrace, hasConfigDef, hashCode, hasNodeConfigDef, hasStepConfigDef, id, isKeep, isReplace, isSource, isTemporary, isUpdate, openForRead, openForReadUnchecked, openForWrite, outgoingScopeFor, prepareResourceForRead, presentSinkFields, presentSourceFields, resolveIncomingOperationArgumentFields, resolveIncomingOperationPassThroughFields, resourceExists, retrieveSinkFields, retrieveSourceFields, setScheme, 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

SplunkSearchTap

public SplunkSearchTap(SplunkScheme scheme,
                       java.lang.String host,
                       int port,
                       java.lang.String search)

Instantiates a new SplunkSearchTap.

Parameters:

scheme - the scheme

host - the host

port - the port

search - the search

SplunkSearchTap

public SplunkSearchTap(SplunkScheme scheme,
                       com.splunk.ServiceArgs serviceArgs,
                       java.lang.String search)

Instantiates a new SplunkSearchTap.

Parameters:

scheme - the scheme

serviceArgs - the args

search - the search

SplunkSearchTap

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

Instantiates a new SplunkSearchTap.

Parameters:

scheme - the scheme

serviceArgs - the args

exportArgs - the export args

search - the search

SplunkSearchTap

public SplunkSearchTap(SplunkScheme scheme,
                       com.splunk.Service service,
                       java.lang.String search)

Instantiates a new SplunkSearchTap.

Parameters:

scheme - the scheme

service - the service

search - the search

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

getSinkFields

public cascading.tuple.Fields getSinkFields()

Overrides:

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

isSink

public final boolean isSink()

Overrides:

isSink 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>

sinkConfInit

public void sinkConfInit(cascading.flow.FlowProcess<? extends java.util.Properties> flowProcess,
                         java.util.Properties conf)

Overrides:

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

prepareResourceForWrite

public boolean prepareResourceForWrite(java.util.Properties conf)

Overrides:

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

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>

commitResource

public boolean commitResource(java.util.Properties conf)

Overrides:

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

rollbackResource

public boolean rollbackResource(java.util.Properties conf)

Overrides:

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

resourceExists

public boolean resourceExists(java.util.Properties conf)

Specified by:

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

getModifiedTime

public long getModifiedTime(java.util.Properties conf)

Specified by:

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

openForWrite

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

Specified by:

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