com.splunk
Class DataModelTransaction

java.lang.Object
  com.splunk.DataModelObject
      com.splunk.DataModelTransaction

public class DataModelTransaction
extends DataModelObject

Represents a datamodel object that inherits directly from BaseTransaction, that is, an object that wraps a Splunk transaction. All children of this object will appears as standard DataModelObject instances.

Method Summary

java.util.Collection<java.lang.String>	getGroupByFields() Return the fields that will be used to group events into transactions.
java.lang.String	getMaxPause() maxPause is the maximum amount of time between two events in a transaction, specified as a string such as "1m" for one minute or "20s" for twenty seconds.
java.lang.String	getMaxSpan() maxSpan is the maximum amount of time (in a Splunk defined format, such as "1m" for one minute or "20s" for twenty seconds) that a single transaction can span.
java.util.Collection<java.lang.String>	getObjectsToGroup() Returns the names of the data model objects that should be unioned and split into transactions.

Methods inherited from class com.splunk.DataModelObject

containsField, createLocalAccelerationJob, createLocalAccelerationJob, createPivotSpecification, getAutoExtractedFields, getCalculation, getCalculations, getConstraints, getDataModel, getDisplayName, getField, getFields, getLineage, getName, getParent, getParentName, getQuery, runQuery, runQuery, runQuery, runQuery

Methods inherited from class java.lang.Object

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

Method Detail

getGroupByFields

public java.util.Collection<java.lang.String> getGroupByFields()

Return the fields that will be used to group events into transactions. Contiguous events with identical values of the fields named in this collection will be grouped into transactions.

getObjectsToGroup

public java.util.Collection<java.lang.String> getObjectsToGroup()

Returns the names of the data model objects that should be unioned and split into transactions.

getMaxSpan

public java.lang.String getMaxSpan()

maxSpan is the maximum amount of time (in a Splunk defined format, such as "1m" for one minute or "20s" for twenty seconds) that a single transaction can span. When a transaction reaches this size, it is automatically ended and a new transaction begun.

Returns:

The maximum time that a transaction can span.

getMaxPause

public java.lang.String getMaxPause()

maxPause is the maximum amount of time between two events in a transaction, specified as a string such as "1m" for one minute or "20s" for twenty seconds. When a transaction has a gap of at least maxPause since its last even, it is ended and a new transaction begun.

Returns:

the maximum pause between events in a transaction.