com.mongodb

Class ParallelScanOptions

java.lang.Object

com.mongodb.ParallelScanOptions

@Immutable
public final class ParallelScanOptions
extends java.lang.Object

The options to use for a parallel collection scan.

Since:

2.12

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParallelScanOptions.Builder A builder for the options

Field Summary

Fields

Modifier and Type	Field and Description
private int	batchSize
private int	numCursors
private ReadPreference	readPreference

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ParallelScanOptions(ParallelScanOptions.Builder builder)

Method Summary

Modifier and Type	Method and 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

Field Detail

numCursors

private final int numCursors

batchSize

private final int batchSize

readPreference

private final ReadPreference readPreference

Constructor Detail

ParallelScanOptions

private ParallelScanOptions(ParallelScanOptions.Builder builder)

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

public ReadPreference getReadPreference()

Gets the read preference to use.

Returns:

read preference