QueryJob¶
-
class
humiolib.QueryJob.
BaseQueryJob
(query_id, base_url, repository, user_token)¶ Base QueryJob class, not meant to be instantiated. This class and its children manage access to queryjobs created on a Humio instance, they are mainly used for extracting results from queryjobs.
-
poll
(**kwargs)¶ Polls the queryjob for the next segment of data, and handles edge cases for data polled
Returns: A data object that contains events of the polled segment and metadata about the poll Return type: PollResult
-
-
class
humiolib.QueryJob.
LiveQueryJob
(query_id, base_url, repository, user_token)¶ Manages a live queryjob
-
class
humiolib.QueryJob.
PollResult
(events, metadata)¶ Result of polling segments of queryjob results. We choose to return these clusters of data, rather than just a list of events, as the metadata returned changes between polls.
-
class
humiolib.QueryJob.
StaticQueryJob
(query_id, base_url, repository, user_token)¶ Manages a static queryjob
-
poll
(**kwargs)¶ Polls next segment of result
Returns: A data object that contains events of the polled segment and metadata about the poll Return type: PollResult
-
poll_until_done
(**kwargs)¶ Create generator for yielding poll results
Returns: A generator for query results Return type: Generator
-