FindOptions

java.lang.Object
- com.mongodb.client.model.FindOptions

```
public final class FindOptions
extends Object
```
The options to apply to a find operation (also commonly referred to as a query).

Since:

3.0

MongoDB documentation
Find
OP_QUERY

Constructor Summary

Constructors
Constructor Description

FindOptions()
Construct a new instance.

FindOptions(FindOptions from)
Construct a new instance by making a shallow copy of the given model.

Constructors
Constructor	Description
`FindOptions()`	Construct a new instance.
`FindOptions(FindOptions from)`	Construct a new instance by making a shallow copy of the given model.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`FindOptions`	`batchSize(int batchSize)`	Sets the number of documents to return per batch.
`FindOptions`	`collation(Collation collation)`	Sets the collation options
`FindOptions`	`comment(String comment)`	Sets the comment to the query.
`FindOptions`	`cursorType(CursorType cursorType)`	Sets the cursor type.
`int`	`getBatchSize()`	Gets the number of documents to return per batch.
`Collation`	`getCollation()`	Returns the collation options
`String`	`getComment()`	Returns the comment to send with the query.
`CursorType`	`getCursorType()`	Get the cursor type.
`Bson`	`getHint()`	Returns the hint for which index to use.
`int`	`getLimit()`	Gets the limit to apply.
`Bson`	`getMax()`	Returns the exclusive upper bound for a specific index.
`long`	`getMaxAwaitTime(TimeUnit timeUnit)`	The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query.
`long`	`getMaxScan()`	Returns the maximum number of documents or index keys to scan when executing the query.
`long`	`getMaxTime(TimeUnit timeUnit)`	Gets the maximum execution time on the server for this operation.
`Bson`	`getMin()`	Returns the minimum inclusive lower bound for a specific index.
`Bson`	`getModifiers()`	Deprecated. use the individual modifier methods instead.
`Bson`	`getProjection()`	Gets a document describing the fields to return for all matching documents.
`int`	`getSkip()`	Gets the number of documents to skip.
`Bson`	`getSort()`	Gets the sort criteria to apply to the query.
`FindOptions`	`hint(Bson hint)`	Sets the hint for which index to use.
`boolean`	`isNoCursorTimeout()`	The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
`boolean`	`isOplogReplay()`	Users should not set this under normal circumstances.
`boolean`	`isPartial()`	Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
`boolean`	`isReturnKey()`	Returns the returnKey.
`boolean`	`isShowRecordId()`	Returns the showRecordId.
`boolean`	`isSnapshot()`	Returns the snapshot.
`FindOptions`	`limit(int limit)`	Sets the limit to apply.
`FindOptions`	`max(Bson max)`	Sets the exclusive upper bound for a specific index.
`FindOptions`	`maxAwaitTime(long maxAwaitTime, TimeUnit timeUnit)`	Sets the maximum await execution time on the server for this operation.
`FindOptions`	`maxScan(long maxScan)`	Sets the maximum number of documents or index keys to scan when executing the query.
`FindOptions`	`maxTime(long maxTime, TimeUnit timeUnit)`	Sets the maximum execution time on the server for this operation.
`FindOptions`	`min(Bson min)`	Sets the minimum inclusive lower bound for a specific index.
`FindOptions`	`modifiers(Bson modifiers)`	Deprecated. use the individual modifier methods instead.
`FindOptions`	`noCursorTimeout(boolean noCursorTimeout)`	The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use.
`FindOptions`	`oplogReplay(boolean oplogReplay)`	Users should not set this under normal circumstances.
`FindOptions`	`partial(boolean partial)`	Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
`FindOptions`	`projection(Bson projection)`	Sets a document describing the fields to return for all matching documents.
`FindOptions`	`returnKey(boolean returnKey)`	Sets the returnKey.
`FindOptions`	`showRecordId(boolean showRecordId)`	Sets the showRecordId.
`FindOptions`	`skip(int skip)`	Sets the number of documents to skip.
`FindOptions`	`snapshot(boolean snapshot)`	Sets the snapshot.
`FindOptions`	`sort(Bson sort)`	Sets the sort criteria to apply to the query.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FindOptions
```
public FindOptions()
```
    Construct a new instance.
  - FindOptions
```
public FindOptions(FindOptions from)
```
    Construct a new instance by making a shallow copy of the given model.
    
    Parameters:
    
    from - model to copy
- Method Detail
  - getLimit
```
public int getLimit()
```
    Gets the limit to apply. The default is null.
    
    Returns:
    
    the limit
    
    MongoDB documentation
    Limit
  - limit
```
public FindOptions limit(int limit)
```
    Sets the limit to apply.
    
    Parameters:
    
    limit - the limit, which may be null
    
    Returns:
    
    this
    
    MongoDB documentation
    Limit
  - getSkip
```
public int getSkip()
```
    Gets the number of documents to skip. The default is 0.
    
    Returns:
    
    the number of documents to skip
    
    MongoDB documentation
    Skip
  - skip
```
public FindOptions skip(int skip)
```
    Sets the number of documents to skip.
    
    Parameters:
    
    skip - the number of documents to skip
    
    Returns:
    
    this
    
    MongoDB documentation
    Skip
  - getMaxTime
```
public long getMaxTime(TimeUnit timeUnit)
```
    Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
    
    Parameters:
    
    timeUnit - the time unit to return the result in
    
    Returns:
    
    the maximum execution time in the given time unit
    
    MongoDB documentation
    Max Time
  - maxTime
```
public FindOptions maxTime(long maxTime,
                           TimeUnit timeUnit)
```
    Sets the maximum execution time on the server for this operation.
    
    Parameters:
    
    maxTime - the max time
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
    
    MongoDB documentation
    Max Time
  - getMaxAwaitTime
```
public long getMaxAwaitTime(TimeUnit timeUnit)
```
    The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored. On servers >= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command. On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value A zero value will be ignored.
    
    Parameters:
    
    timeUnit - the time unit to return the result in
    
    Returns:
    
    the maximum await execution time in the given time unit
    
    Since:
    
    3.2
    
    MongoDB documentation
    Max Time
  - maxAwaitTime
```
public FindOptions maxAwaitTime(long maxAwaitTime,
                                TimeUnit timeUnit)
```
    Sets the maximum await execution time on the server for this operation.
    
    Parameters:
    
    maxAwaitTime - the max await time. A zero value will be ignored, and indicates that the driver should respect the server's default value
    
    timeUnit - the time unit, which may not be null
    
    Returns:
    
    this
    
    Since:
    
    3.2
    
    MongoDB documentation
    Max Time
  - getBatchSize
```
public int getBatchSize()
```
    Gets the number of documents to return per batch. Default to 0, which indicates that the server chooses an appropriate batch size.
    
    Returns:
    
    the batch size
    
    MongoDB documentation
    Batch Size
  - batchSize
```
public FindOptions batchSize(int batchSize)
```
    Sets the number of documents to return per batch.
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    MongoDB documentation
    Batch Size
  - getModifiers
```
@Deprecated
@Nullable
public Bson getModifiers()
```
    Deprecated. use the individual modifier methods instead.
    
    Gets the query modifiers to apply to this operation. The default is not to apply any modifiers.
    
    Returns:
    
    the query modifiers, which may be null
    
    MongoDB documentation
    Query Modifiers
  - modifiers
```
@Deprecated
public FindOptions modifiers(@Nullable
                             Bson modifiers)
```
    Deprecated. use the individual modifier methods instead.
    
    Sets the query modifiers to apply to this operation.
    
    Parameters:
    
    modifiers - the query modifiers to apply, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Query Modifiers
  - getProjection
```
@Nullable
public Bson getProjection()
```
    Gets a document describing the fields to return for all matching documents.
    
    Returns:
    
    the project document, which may be null
    
    MongoDB documentation
    Projection
  - projection
```
public FindOptions projection(@Nullable
                              Bson projection)
```
    Sets a document describing the fields to return for all matching documents.
    
    Parameters:
    
    projection - the project document, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Projection
  - getSort
```
@Nullable
public Bson getSort()
```
    Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.
    
    Returns:
    
    a document describing the sort criteria
    
    MongoDB documentation
    Sort
  - sort
```
public FindOptions sort(@Nullable
                        Bson sort)
```
    Sets the sort criteria to apply to the query.
    
    Parameters:
    
    sort - the sort criteria, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Sort
  - isNoCursorTimeout
```
public boolean isNoCursorTimeout()
```
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. If true, that timeout is disabled.
    
    Returns:
    
    true if cursor timeout is disabled
  - noCursorTimeout
```
public FindOptions noCursorTimeout(boolean noCursorTimeout)
```
    The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
    
    Parameters:
    
    noCursorTimeout - true if cursor timeout is disabled
    
    Returns:
    
    this
  - isOplogReplay
```
public boolean isOplogReplay()
```
    Users should not set this under normal circumstances.
    
    Returns:
    
    if oplog replay is enabled
  - oplogReplay
```
public FindOptions oplogReplay(boolean oplogReplay)
```
    Users should not set this under normal circumstances.
    
    Parameters:
    
    oplogReplay - if oplog replay is enabled
    
    Returns:
    
    this
  - isPartial
```
public boolean isPartial()
```
    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
    
    Returns:
    
    if partial results for sharded clusters is enabled
  - partial
```
public FindOptions partial(boolean partial)
```
    Get partial results from a sharded cluster if one or more shards are unreachable (instead of throwing an error).
    
    Parameters:
    
    partial - if partial results for sharded clusters is enabled
    
    Returns:
    
    this
  - getCursorType
```
public CursorType getCursorType()
```
    Get the cursor type.
    
    Returns:
    
    the cursor type
  - cursorType
```
public FindOptions cursorType(CursorType cursorType)
```
    Sets the cursor type.
    
    Parameters:
    
    cursorType - the cursor type
    
    Returns:
    
    this
  - getCollation
```
@Nullable
public Collation getCollation()
```
    Returns the collation options
    
    Returns:
    
    the collation options
    
    Since:
    
    3.4
    
    Since server release
    3.4
  - collation
```
public FindOptions collation(@Nullable
                             Collation collation)
```
    Sets the collation options
    A null value represents the server default.
    
    Parameters:
    
    collation - the collation options to use
    
    Returns:
    
    this
    
    Since:
    
    3.4
    
    Since server release
    3.4
  - getComment
```
@Nullable
public String getComment()
```
    Returns the comment to send with the query. The default is not to include a comment with the query.
    
    Returns:
    
    the comment
    
    Since:
    
    3.5
  - comment
```
public FindOptions comment(@Nullable
                           String comment)
```
    Sets the comment to the query. A null value means no comment is set.
    
    Parameters:
    
    comment - the comment
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getHint
```
@Nullable
public Bson getHint()
```
    Returns the hint for which index to use. The default is not to set a hint.
    
    Returns:
    
    the hint
    
    Since:
    
    3.5
  - hint
```
public FindOptions hint(@Nullable
                        Bson hint)
```
    Sets the hint for which index to use. A null value means no hint is set.
    
    Parameters:
    
    hint - the hint
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getMax
```
@Nullable
public Bson getMax()
```
    Returns the exclusive upper bound for a specific index. By default there is no max bound.
    
    Returns:
    
    the max
    
    Since:
    
    3.5
  - max
```
public FindOptions max(@Nullable
                       Bson max)
```
    Sets the exclusive upper bound for a specific index. A null value means no max is set.
    
    Parameters:
    
    max - the max
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getMin
```
@Nullable
public Bson getMin()
```
    Returns the minimum inclusive lower bound for a specific index. By default there is no min bound.
    
    Returns:
    
    the min
    
    Since:
    
    3.5
  - min
```
public FindOptions min(@Nullable
                       Bson min)
```
    Sets the minimum inclusive lower bound for a specific index. A null value means no max is set.
    
    Parameters:
    
    min - the min
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - getMaxScan
```
public long getMaxScan()
```
    Returns the maximum number of documents or index keys to scan when executing the query. A zero value or less will be ignored, and indicates that the driver should respect the server's default value.
    
    Returns:
    
    the maxScan
    
    Since:
    
    3.5
  - maxScan
```
public FindOptions maxScan(long maxScan)
```
    Sets the maximum number of documents or index keys to scan when executing the query. A zero value or less will be ignored, and indicates that the driver should respect the server's default value.
    
    Parameters:
    
    maxScan - the maxScan
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - isReturnKey
```
public boolean isReturnKey()
```
    Returns the returnKey. If true the find operation will return only the index keys in the resulting documents. Default value is false. If returnKey is true and the find command does not use an index, the returned documents will be empty.
    
    Returns:
    
    the returnKey
    
    Since:
    
    3.5
  - returnKey
```
public FindOptions returnKey(boolean returnKey)
```
    Sets the returnKey. If true the find operation will return only the index keys in the resulting documents.
    
    Parameters:
    
    returnKey - the returnKey
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - isShowRecordId
```
public boolean isShowRecordId()
```
    Returns the showRecordId. Determines whether to return the record identifier for each document. If true, adds a field $recordId to the returned documents. The default is false.
    
    Returns:
    
    the showRecordId
    
    Since:
    
    3.5
  - showRecordId
```
public FindOptions showRecordId(boolean showRecordId)
```
    Sets the showRecordId. Set to true to add a field $recordId to the returned documents.
    
    Parameters:
    
    showRecordId - the showRecordId
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - isSnapshot
```
public boolean isSnapshot()
```
    Returns the snapshot. Prevents the cursor from returning a document more than once because of an intervening write operation. The default is false.
    
    Returns:
    
    the snapshot
    
    Since:
    
    3.5
  - snapshot
```
public FindOptions snapshot(boolean snapshot)
```
    Sets the snapshot. If true it prevents the cursor from returning a document more than once because of an intervening write operation.
    
    Parameters:
    
    snapshot - the snapshot
    
    Returns:
    
    this
    
    Since:
    
    3.5
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FindOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindOptions

FindOptions

Method Detail

getLimit

limit

getSkip

skip

getMaxTime

maxTime

getMaxAwaitTime

maxAwaitTime

getBatchSize

batchSize

getModifiers

modifiers

getProjection

projection

getSort

sort

isNoCursorTimeout

noCursorTimeout

isOplogReplay

oplogReplay

isPartial

partial

getCursorType

cursorType

getCollation

collation

getComment

comment

getHint

hint

getMax

max

getMin

min

getMaxScan

maxScan

isReturnKey

returnKey

isShowRecordId

showRecordId

isSnapshot

snapshot

toString