MongoFindOptions (data-parent 3.3.0 API)

@Retention(value=RUNTIME)
 @Target(value={ANNOTATION_TYPE,METHOD,TYPE})
 @Documented
 @Inherited
public @interface MongoFindOptions

Defines a custom MongoDB find query options.

Since:: 3.3.0
Author:: Denis Stepanov

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`boolean`	`allowDiskUse` The allowDiskUse.
`int`	`batchSize` The batchSize.
`java.lang.String`	`comment` The comment.
`com.mongodb.CursorType`	`cursorType` The cursorType.
`java.lang.String`	`hint` The hint.
`int`	`limit` The limit.
`java.lang.String`	`max` The max.
`long`	`maxAwaitTimeMS` The maxAwaitTimeMS.
`long`	`maxTimeMS` The maxTimeMS.
`java.lang.String`	`min` The min.
`boolean`	`noCursorTimeout` The cursorType.
`boolean`	`partial` The partial.
`boolean`	`returnKey` The returnKey.
`boolean`	`showRecordId` The showRecordId.
`int`	`skip` The skip.

- Element Detail
  - batchSize
```
public abstract int batchSize
```
    The batchSize.
    
    Returns:
    
    The batchSize value
    
    Default:
    
    -1
- - skip
```
public abstract int skip
```
    The skip.
    
    Returns:
    
    The skip value
    
    Default:
    
    -1
- - limit
```
public abstract int limit
```
    The limit.
    
    Returns:
    
    The limit value
    
    Default:
    
    -1
- - maxTimeMS
```
public abstract long maxTimeMS
```
    The maxTimeMS.
    
    Returns:
    
    The maxTimeMS value
    
    Default:
    
    -1L
- - maxAwaitTimeMS
```
public abstract long maxAwaitTimeMS
```
    The maxAwaitTimeMS.
    
    Returns:
    
    The maxAwaitTimeMS value
    
    Default:
    
    -1L
- - cursorType
```
public abstract com.mongodb.CursorType cursorType
```
    The cursorType.
    
    Returns:
    
    The cursorType value
    
    Default:
    
    com.mongodb.CursorType.NonTailable
- - noCursorTimeout
```
public abstract boolean noCursorTimeout
```
    The cursorType.
    
    Returns:
    
    The cursorType value
    
    Default:
    
    false
- - partial
```
public abstract boolean partial
```
    The partial.
    
    Returns:
    
    The partial value
    
    Default:
    
    false
- - comment
```
public abstract java.lang.String comment
```
    The comment.
    
    Returns:
    
    The comment value
    
    Default:
    
    ""
- - hint
```
public abstract java.lang.String hint
```
    The hint.
    
    Returns:
    
    The hint value
    
    Default:
    
    ""
- - max
```
public abstract java.lang.String max
```
    The max.
    
    Returns:
    
    The max value
    
    Default:
    
    ""
- - min
```
public abstract java.lang.String min
```
    The min.
    
    Returns:
    
    The min value
    
    Default:
    
    ""
- - returnKey
```
public abstract boolean returnKey
```
    The returnKey.
    
    Returns:
    
    The returnKey value
    
    Default:
    
    false
- - showRecordId
```
public abstract boolean showRecordId
```
    The showRecordId.
    
    Returns:
    
    The showRecordId value
    
    Default:
    
    false
- - allowDiskUse
```
public abstract boolean allowDiskUse
```
    The allowDiskUse.
    
    Returns:
    
    The allowDiskUse value
    
    Default:
    
    false

Annotation Type MongoFindOptions

Optional Element Summary

Element Detail

batchSize

skip

limit

maxTimeMS

maxAwaitTimeMS

cursorType

noCursorTimeout

partial

comment

hint

max

min

returnKey

showRecordId

allowDiskUse