Package com.attivio.sdk.search

Enum StreamingQueryRequest.DocumentStreamingMode

java.lang.Object

java.lang.Enum<StreamingQueryRequest.DocumentStreamingMode>

com.attivio.sdk.search.StreamingQueryRequest.DocumentStreamingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StreamingQueryRequest.DocumentStreamingMode>

Enclosing class:

StreamingQueryRequest

public static enum StreamingQueryRequest.DocumentStreamingMode
extends java.lang.Enum<StreamingQueryRequest.DocumentStreamingMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOCUMENT_IDS_ONLY	Only stream back document ID's.
FULL_DOCUMENTS	Stream back full documents including all fields requested in the QueryRequest.
NONE	Do not stream any document information, this is the default.

Method Summary

Modifier and Type	Method	Description
static StreamingQueryRequest.DocumentStreamingMode	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static StreamingQueryRequest.DocumentStreamingMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final StreamingQueryRequest.DocumentStreamingMode NONE

Do not stream any document information, this is the default.

DOCUMENT_IDS_ONLY

public static final StreamingQueryRequest.DocumentStreamingMode DOCUMENT_IDS_ONLY

Only stream back document ID's.

FULL_DOCUMENTS

public static final StreamingQueryRequest.DocumentStreamingMode FULL_DOCUMENTS

Stream back full documents including all fields requested in the QueryRequest.

Method Detail

values

public static StreamingQueryRequest.DocumentStreamingMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StreamingQueryRequest.DocumentStreamingMode c : StreamingQueryRequest.DocumentStreamingMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StreamingQueryRequest.DocumentStreamingMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null