Package io.vertx.mongo.client

Class ListDatabasesOptions

java.lang.Object

io.vertx.mongo.client.ListDatabasesOptions

public class ListDatabasesOptions
extends java.lang.Object

Options for ListDatabases.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
ListDatabasesOptions()

Method Summary

Modifier and Type	Method	Description
java.lang.Integer	getBatchSize()
JsonObject	getFilter()
java.lang.Long	getMaxTime()
java.lang.Boolean	isAuthorizedDatabasesOnly()
java.lang.Boolean	isNameOnly()
ListDatabasesOptions	setAuthorizedDatabasesOnly(java.lang.Boolean authorizedDatabasesOnly)	Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user is authorized to see.
ListDatabasesOptions	setBatchSize(java.lang.Integer batchSize)	Sets the number of documents to return per batch.
ListDatabasesOptions	setFilter(JsonObject filter)	Sets the query filter to apply to the returned database names.
ListDatabasesOptions	setMaxTime(java.lang.Long maxTime)	Sets the maximum execution time on the server for this operation.
ListDatabasesOptions	setNameOnly(java.lang.Boolean nameOnly)	Sets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListDatabasesOptions

public ListDatabasesOptions()

Method Detail

setMaxTime

public ListDatabasesOptions setMaxTime(java.lang.Long maxTime)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time (in milliseconds)

Returns:

this

MongoDB documentation

Max Time

getMaxTime

public java.lang.Long getMaxTime()

setFilter

public ListDatabasesOptions setFilter(JsonObject filter)

Sets the query filter to apply to the returned database names.

Parameters:

filter - the filter, which may be null.

Returns:

this

Since:

1.7

Since server release

3.4.2

getFilter

public JsonObject getFilter()

setNameOnly

public ListDatabasesOptions setNameOnly(java.lang.Boolean nameOnly)

Sets the nameOnly flag that indicates whether the command should return just the database names or return the database names and size information.

Parameters:

nameOnly - the nameOnly flag, which may be null

Returns:

this

Since:

1.7

Since server release

3.4.3

isNameOnly

public java.lang.Boolean isNameOnly()

setAuthorizedDatabasesOnly

public ListDatabasesOptions setAuthorizedDatabasesOnly(java.lang.Boolean authorizedDatabasesOnly)

Sets the authorizedDatabasesOnly flag that indicates whether the command should return just the databases which the user is authorized to see.

Parameters:

authorizedDatabasesOnly - the authorizedDatabasesOnly flag, which may be null

Returns:

this

Since:

4.1

Since server release

4.0

isAuthorizedDatabasesOnly

public java.lang.Boolean isAuthorizedDatabasesOnly()

setBatchSize

public ListDatabasesOptions setBatchSize(java.lang.Integer 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

getBatchSize

public java.lang.Integer getBatchSize()