Package 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

MongoDB documentation

listCollections

Method Summary

Modifier and Type	Method	Description
ListCollectionsIterable<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
ListCollectionsIterable<TResult>	comment(String comment)	Sets the comment for this operation.
ListCollectionsIterable<TResult>	comment(BsonValue comment)	Sets the comment for this operation.
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 java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.mongodb.client.MongoIterable

cursor, first, into, iterator, map

Method Details

filter

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

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

comment

ListCollectionsIterable<TResult> comment(@Nullable
 String comment)

Sets the comment for this operation. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

Since:

4.6

Since server release

4.4

comment

ListCollectionsIterable<TResult> comment(@Nullable
 BsonValue comment)

Sets the comment for this operation. A null value means no comment is set.

Parameters:

comment - the comment

Returns:

this

Since:

4.6

Since server release

4.4