Package com.mongodb
Class ParallelScanOptions
- java.lang.Object
 - 
- com.mongodb.ParallelScanOptions
 
 
- 
@Deprecated @Immutable public final class ParallelScanOptions extends Object
Deprecated.the parallelCollectionScan command will be removed in MongoDB 4.2The options to use for a parallel collection scan.- Since:
 - 2.12
 - MongoDB documentation
 - Parallel Collection Scan
 
 
- 
- 
Nested Class Summary
Nested Classes Modifier and Type Class Description static classParallelScanOptions.BuilderDeprecated.A builder for the options 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ParallelScanOptions.Builderbuilder()Deprecated.Create a builder for the optionsintgetBatchSize()Deprecated.Gets the batch size to use for each cursor.intgetNumCursors()Deprecated.Gets the number of cursors requested.ReadPreferencegetReadPreference()Deprecated.Gets the read preference to use. 
 - 
 
- 
- 
Method Detail
- 
builder
public static ParallelScanOptions.Builder builder()
Deprecated.Create a builder for the options- Returns:
 - the builder
 
 
- 
getNumCursors
public int getNumCursors()
Deprecated.Gets the number of cursors requested. The default value is 1.- Returns:
 - number of cursors requested.
 
 
- 
getBatchSize
public int getBatchSize()
Deprecated.Gets the batch size to use for each cursor. The default value is 0, which tells the server to use its own default batch size.- Returns:
 - batch size
 
 
- 
getReadPreference
@Nullable public ReadPreference getReadPreference()
Deprecated.Gets the read preference to use.- Returns:
 - read preference
 
 
 - 
 
 -