ListCollectionsOptions

java.lang.Object
- io.vertx.mongo.client.ListCollectionsOptions

public class ListCollectionsOptions
extends java.lang.Object

Options for ListCollections.

Since:: 1.0

Constructor Summary

Constructors
Constructor Description

ListCollectionsOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Integer`	`getBatchSize()`
`JsonObject`	`getFilter()`
`java.lang.Long`	`getMaxTime()`
`ListCollectionsOptions`	`setBatchSize(java.lang.Integer batchSize)`	Sets the number of documents to return per batch.
`ListCollectionsOptions`	`setFilter(JsonObject filter)`	Sets the query filter to apply to the query.
`ListCollectionsOptions`	`setMaxTime(java.lang.Long maxTime)`	Sets the maximum execution time on the server for this operation.

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

- Constructor Detail
  - ListCollectionsOptions
```
public ListCollectionsOptions()
```
- Method Detail
  - setFilter
```
public ListCollectionsOptions setFilter(JsonObject filter)
```
    Sets the query filter to apply to the query.
    
    Parameters:
    
    filter - the filter, which may be null.
    
    Returns:
    
    this
    
    MongoDB documentation
    Filter
  - getFilter
```
public JsonObject getFilter()
```
  - setMaxTime
```
public ListCollectionsOptions setMaxTime(java.lang.Long maxTime)
```
    Sets the maximum execution time on the server for this operation.
    
    Parameters:
    
    maxTime - the max time (in milliseconds)
    
    Returns:
    
    this
    
    MongoDB documentation
    Max Time
  - getMaxTime
```
public java.lang.Long getMaxTime()
```
  - setBatchSize
```
public ListCollectionsOptions setBatchSize(java.lang.Integer batchSize)
```
    Sets the number of documents to return per batch.
    Overrides the Subscription.request(long) value for setting the batch size, allowing for fine grained control over the underlying cursor.
    
    Parameters:
    
    batchSize - the batch size
    
    Returns:
    
    this
    
    Since:
    
    1.8
    
    MongoDB documentation
    Batch Size
  - getBatchSize
```
public java.lang.Integer getBatchSize()
```