Package stroom.query.api.v2

Class SearchRequest.Builder

java.lang.Object

stroom.query.api.v2.SearchRequest.Builder

Enclosing class:

SearchRequest

public static class SearchRequest.Builder
extends java.lang.Object

Builder for constructing a SearchRequest

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SearchRequest.Builder	addResultRequests(ResultRequest... values)
SearchRequest	build()
SearchRequest.Builder	dateTimeLocale(java.lang.String value)
SearchRequest.Builder	incremental(java.lang.Boolean value)
SearchRequest.Builder	key(java.lang.String uuid)	Shortcut function to add a key value in one go
SearchRequest.Builder	key(QueryKey value)
SearchRequest.Builder	query(Query value)
SearchRequest.Builder	timeout(java.lang.Long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

key

public SearchRequest.Builder key(QueryKey value)

Parameters:

value - A unique key to identify the instance of the search by. This key is used to identify multiple requests for the same search when running in incremental mode.

Returns:

The SearchRequest.Builder, enabling method chaining

key

public SearchRequest.Builder key(java.lang.String uuid)

Shortcut function to add a key value in one go

Parameters:

uuid - The UUID of the query key

Returns:

this builder

query

public SearchRequest.Builder query(Query value)

Parameters:

value - The query terms for the search

Returns:

The SearchRequest.Builder, enabling method chaining

addResultRequests

public SearchRequest.Builder addResultRequests(ResultRequest... values)

Parameters:

values - The various forms of results required by the caller.

Returns:

The SearchRequest.Builder, enabling method chaining

dateTimeLocale

public SearchRequest.Builder dateTimeLocale(java.lang.String value)

Parameters:

value - The date time locale to apply to any date/time results

Returns:

The SearchRequest.Builder, enabling method chaining

incremental

public SearchRequest.Builder incremental(java.lang.Boolean value)

Parameters:

value - If true the response will contain all results found so far. Future requests for the same query key may return more results. Intended for use on longer running searches to allow partial result sets to be returned as soon as they are available rather than waiting for the full result set.

Returns:

The SearchRequest.Builder, enabling method chaining

timeout

public SearchRequest.Builder timeout(java.lang.Long value)

Parameters:

value - See SearchRequest(QueryKey, Query, List, String, Boolean, Long)

Returns:

The SearchRequest.Builder, enabling method chaining

build

public SearchRequest build()