com.mongodb.client

Interface ListCollectionsIterable<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Iterable<TResult>, MongoIterable<TResult>

public interface ListCollectionsIterable<TResult>
extends MongoIterable<TResult>

Iterable for ListCollections.

Since:

3.0

Method Summary

Methods

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

Methods inherited from interface com.mongodb.client.MongoIterable

first, forEach, into, iterator, map

Method Detail

filter

ListCollectionsIterable<TResult> filter(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

ListCollectionsIterable<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

MongoDB documentation

Max Time

batchSize

ListCollectionsIterable<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