Package com.mongodb.client

Interface DistinctIterable<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Iterable<TResult>, MongoIterable<TResult>

public interface DistinctIterable<TResult>
extends MongoIterable<TResult>

Iterable interface for distinct.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
DistinctIterable<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
DistinctIterable<TResult>	collation(Collation collation)	Sets the collation options
DistinctIterable<TResult>	filter(Bson filter)	Sets the query filter to apply to the query.
DistinctIterable<TResult>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.mongodb.client.MongoIterable

cursor, first, forEach, into, iterator, map

Method Detail

filter

DistinctIterable<TResult> filter(@Nullable
                                 Bson filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

maxTime

DistinctIterable<TResult> 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

batchSize

DistinctIterable<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Specified by:

batchSize in interface MongoIterable<TResult>

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size

collation

DistinctIterable<TResult> 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