StreamMode (platform/sdk 5.6.3.0 API)

java.lang.Object
- java.lang.Enum<StreamMode>
- - com.attivio.client.streaming.StreamMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StreamMode>
```
public enum StreamMode
extends java.lang.Enum<StreamMode>
```
Indicates mode for how to stream documents.

Enum Constant Summary

Enum Constants
Enum Constant Description

FULL
Stream full documents.

ID
Stream document ids only.

NONE
Do not stream documents.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static StreamMode`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static StreamMode[]`	`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 StreamMode NONE
```
    Do not stream documents.
  - ID
```
public static final StreamMode ID
```
    Stream document ids only. Use StreamedResponseClient.getDocumentIds() to receive stream.
  - FULL
```
public static final StreamMode FULL
```
    Stream full documents. Use {@link StreamedResponseClient.getDocuments()} to receive stream.
- Method Detail
  - values
```
public static StreamMode[] 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 (StreamMode c : StreamMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StreamMode 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