com.splunk
Class LimitPivotFilter

java.lang.Object
  com.splunk.PivotFilter
      com.splunk.LimitPivotFilter

public class LimitPivotFilter
extends PivotFilter

Represents a limit on the events shown in a pivot by sorting them according to some field, then taking the specified number from the beginning or end of the list.

Method Summary

java.lang.String	getAttributeName() Return the name of the field to use for sorting.
java.lang.String[]	getAttributeOwnerLineage()
int	getLimit()
SortDirection	getSortDirection()
StatsFunction	getStatsFunction()

Methods inherited from class com.splunk.PivotFilter

getFieldName, getOwnerLineage, getOwnerName, getType

Methods inherited from class java.lang.Object

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

Method Detail

getAttributeName

public java.lang.String getAttributeName()

Return the name of the field to use for sorting.

getAttributeOwnerLineage

public java.lang.String[] getAttributeOwnerLineage()

Returns:

a list of the names of DataModelObjects from the most remote ancestor that is not a built-in parent to this data model object.

getSortDirection

public SortDirection getSortDirection()

Returns:

whether the limit takes the lowest (SortDirection.ASCENDING) or highest (SortDirection.DESCENDING) values from the sorted list.

getLimit

public int getLimit()

Returns:

The number of values from the sorted list to allow through this filter.

getStatsFunction

public StatsFunction getStatsFunction()

Returns:

The stats function to use for aggregation before sorting.