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.

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<String>	groupByFields
protected String	maxPause
protected String	maxSpan
protected Collection<String>	objectsToGroup

Method Summary

Modifier and Type	Method and Description
Collection<String>	getGroupByFields()
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.
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.
Collection<String>	getObjectsToGroup()

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

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

Field Detail

groupByFields

protected Collection<String> groupByFields

objectsToGroup

protected Collection<String> objectsToGroup

maxSpan

protected String maxSpan

maxPause

protected String maxPause

Method Detail

getGroupByFields

public Collection<String> getGroupByFields()

Returns:

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 Collection<String> getObjectsToGroup()

Returns:

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

getMaxSpan

public 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 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.