Package com.mongodb.reactivestreams.client

Interface ListCollectionsPublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

Publisher<TResult>

public interface ListCollectionsPublisher<TResult>
extends Publisher<TResult>

Publisher interface for ListCollections.

Since:

1.0

MongoDB documentation

listCollections

Method Summary

Modifier and Type	Method	Description
ListCollectionsPublisher<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
ListCollectionsPublisher<TResult>	comment(String comment)	Sets the comment for this operation.
ListCollectionsPublisher<TResult>	comment(BsonValue comment)	Sets the comment for this operation.
ListCollectionsPublisher<TResult>	filter(Bson filter)	Sets the query filter to apply to the query.
Publisher<TResult>	first()	Helper to return a publisher limited to the first result.
ListCollectionsPublisher<TResult>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
ListCollectionsPublisher<TResult>	timeoutMode(TimeoutMode timeoutMode)	Sets the timeoutMode for the cursor.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Details

filter

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

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

ListCollectionsPublisher<TResult> batchSize(int 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

comment

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

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

timeoutMode

@Alpha(CLIENT)
ListCollectionsPublisher<TResult> timeoutMode(TimeoutMode timeoutMode)

Sets the timeoutMode for the cursor.

Requires the timeout to be set, either in the MongoClientSettings, via MongoDatabase or via MongoCollection

Parameters:

timeoutMode - the timeout mode

Returns:

this

Since:

5.2

first

Publisher<TResult> first()

Helper to return a publisher limited to the first result.

Returns:

a Publisher which will contain a single item.

Since:

1.8