Package io.vertx.mongo.client

Class DistinctOptions

java.lang.Object

io.vertx.mongo.client.DistinctOptions

public class DistinctOptions
extends java.lang.Object

Options for distinct.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
DistinctOptions()

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getBatchSize()
Collation	getCollation()
JsonObject	getFilter()
java.lang.Long	getMaxTime()
DistinctOptions	setBatchSize(java.lang.Integer batchSize)	Sets the number of documents to return per batch.
DistinctOptions	setCollation(Collation collation)	Sets the collation options
DistinctOptions	setFilter(JsonObject filter)	Sets the query filter to apply to the query.
DistinctOptions	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

DistinctOptions

public DistinctOptions()

Method Detail

setFilter

public DistinctOptions 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 DistinctOptions 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

getMaxTime

public java.lang.Long getMaxTime()

setCollation

public DistinctOptions setCollation(Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

1.3

Since server release

3.4

getCollation

public Collation getCollation()

setBatchSize

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