Package com.mongodb

Class ParallelScanOptions

java.lang.Object

com.mongodb.ParallelScanOptions

@Immutable
public final class ParallelScanOptions
extends Object

The 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 class	ParallelScanOptions.Builder	A builder for the options

Method Summary

Modifier and Type	Method	Description
static ParallelScanOptions.Builder	builder()	Create a builder for the options
int	getBatchSize()	Gets the batch size to use for each cursor.
int	getNumCursors()	Gets the number of cursors requested.
ReadPreference	getReadPreference()	Gets the read preference to use.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ParallelScanOptions.Builder builder()

Create a builder for the options

Returns:

the builder

getNumCursors

public int getNumCursors()

Gets the number of cursors requested. The default value is 1.

Returns:

number of cursors requested.

getBatchSize

public int getBatchSize()

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()

Gets the read preference to use.

Returns:

read preference