com.mongodb.reactivestreams.client

Interface ListCollectionsPublisher<TResult>

Type Parameters:

TResult - The type of the result.

All Superinterfaces:

org.reactivestreams.Publisher<TResult>

public interface ListCollectionsPublisher<TResult>
extends org.reactivestreams.Publisher<TResult>

Publisher interface for ListCollections.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
ListCollectionsPublisher<TResult>	batchSize(int batchSize) Sets the number of documents to return per batch.
ListCollectionsPublisher<TResult>	filter(Bson filter) Sets the query filter to apply to the query.
org.reactivestreams.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.

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Method Detail

filter

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

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

first

org.reactivestreams.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