com.splunk

Class Pivot

java.lang.Object

com.splunk.Pivot

public class Pivot
extends Object

A call of pivot on a PivotSpecification object queries splunkd to get the queries corresponding to that pivot, which will be returned as an instance of the Pivot class. Pivot is a container for the various queries for different purposes returned by the server.

Method Summary

Modifier and Type	Method and Description
String	getAcceleratedQuery()
String	getPivotQuery()
String	getPrettyQuery()
String	getQueryForDrilldown()
String	getRawQuery()
Job	run()
Job	run(JobArgs args)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPivotQuery

public String getPivotQuery()

Returns:

a SPL query using the pivot search command to implement this pivot.

getAcceleratedQuery

public String getAcceleratedQuery()

Returns:

an SPL query that uses tstats and a tsidx namespace to implement an accelerated version of this pivot. If there is no acceleration available, it returns null.

getQueryForDrilldown

public String getQueryForDrilldown()

Returns:

an SPL query implementing this pivot that is appropriate for use when implementing drilldown interfaces.

getPrettyQuery

public String getPrettyQuery()

Returns:

a readable version of the SPL query implementing this pivot.

getRawQuery

public String getRawQuery()

Returns:

an SPL query implementing this pivot with no reference to the pivot command.

run

public Job run()

Returns:

a Job object running this pivot, accelerated if possible.

run

public Job run(JobArgs args)

Parameters:

args - options for creating a Job

Returns:

a Job object running this pivot, accelerated if possible.