com.splunk

Interface SearchResults

All Superinterfaces:

java.lang.Iterable<Event>

All Known Implementing Classes:

ResultsReader, ResultsReaderCsv, ResultsReaderJson, ResultsReaderXml

public interface SearchResults
extends java.lang.Iterable<Event>

The SearchResults interface represents Splunk search results.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getFields() Returns a collection of field names from the results.
boolean	isPreview() Indicates whether the results are a preview from an unfinished search.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

isPreview

boolean isPreview()

Indicates whether the results are a preview from an unfinished search.

Returns:

true if the results are a preview, false if not.

getFields

java.util.Collection<java.lang.String> getFields()

Returns a collection of field names from the results.

Returns:

A collection of field names.

Note that any given result will contain a subset of these fields.