Package com.attivio.sdk.search

Class StreamingQueryRequest

java.lang.Object

com.attivio.sdk.search.StreamingQueryRequest

public class StreamingQueryRequest
extends java.lang.Object

Models the basic properties of a query request that is meant to provide streaming results.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamingQueryRequest.DocumentStreamingMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamingQueryRequest()
	StreamingQueryRequest(QueryRequest queryRequest)
	StreamingQueryRequest(QueryRequest queryRequest, boolean streamFacets)
	StreamingQueryRequest(QueryRequest queryRequest, StreamingQueryRequest.DocumentStreamingMode documentStreamingMode)
	StreamingQueryRequest(QueryRequest queryRequest, StreamingQueryRequest.DocumentStreamingMode documentStreamingMode, boolean streamFacets)

Method Summary

Modifier and Type	Method	Description
int	getBufferSize()	Registers the buffer size (in bytes) to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;
long	getConnectTimeout()	Registers the connection timeout (milliseconds) to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;
StreamingQueryRequest.DocumentStreamingMode	getDocumentStreamingMode()
long	getKeepAlivePingFrequency()	Registers a time (milliseconds) to be used to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;
QueryRequest	getQueryRequest()
boolean	isStreamFacets()	Registers a flag indicating whether or not to stream facets.
void	setBufferSize(int bufferSize)
void	setConnectTimeout(long connectTimeout)
void	setDocumentStreamingMode(StreamingQueryRequest.DocumentStreamingMode documentStreamingMode)
void	setKeepAlivePingFrequency(long keepAlivePingFrequency)
void	setQueryRequest(QueryRequest queryRequest)
void	setStreamFacets(boolean streamFacets)

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamingQueryRequest

protected StreamingQueryRequest()

StreamingQueryRequest

public StreamingQueryRequest(QueryRequest queryRequest)

StreamingQueryRequest

public StreamingQueryRequest(QueryRequest queryRequest,
                             StreamingQueryRequest.DocumentStreamingMode documentStreamingMode,
                             boolean streamFacets)

StreamingQueryRequest

public StreamingQueryRequest(QueryRequest queryRequest,
                             boolean streamFacets)

StreamingQueryRequest

public StreamingQueryRequest(QueryRequest queryRequest,
                             StreamingQueryRequest.DocumentStreamingMode documentStreamingMode)

Method Detail

getConnectTimeout

public long getConnectTimeout()

Registers the connection timeout (milliseconds) to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;

The client must connect to the stream within this timeout or the query will fail.

The default is 60,000 milliseconds or 1 minute.

getBufferSize

public int getBufferSize()

Registers the buffer size (in bytes) to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;

The default is 16,384 bytes or 16 kilobytes.

getDocumentStreamingMode

public StreamingQueryRequest.DocumentStreamingMode getDocumentStreamingMode()

isStreamFacets

public boolean isStreamFacets()

Registers a flag indicating whether or not to stream facets. This flag is used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;

The default is not to stream facets.

getKeepAlivePingFrequency

public long getKeepAlivePingFrequency()

Registers a time (milliseconds) to be used to be used by this StreamingResponseClientBuilder when building a StreamingQueryResponse;

This is the time between keep alive ping attempts.

A value of 0 indicates not to attempt to keep the connection alive. This is the default.

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

setBufferSize

public void setBufferSize(int bufferSize)

setDocumentStreamingMode

public void setDocumentStreamingMode(StreamingQueryRequest.DocumentStreamingMode documentStreamingMode)

setStreamFacets

public void setStreamFacets(boolean streamFacets)

setKeepAlivePingFrequency

public void setKeepAlivePingFrequency(long keepAlivePingFrequency)

getQueryRequest

public QueryRequest getQueryRequest()

setQueryRequest

public void setQueryRequest(QueryRequest queryRequest)