com.mongodb.client.model

Class DBCollectionDistinctOptions

java.lang.Object

com.mongodb.client.model.DBCollectionDistinctOptions

public class DBCollectionDistinctOptions
extends java.lang.Object

The options for a distinct operation.

Since:

3.4

Constructor Summary

Constructors

Constructor and Description
DBCollectionDistinctOptions() Construct a new instance

Method Summary

Modifier and Type	Method and Description
DBCollectionDistinctOptions	collation(Collation collation) Sets the collation
DBCollectionDistinctOptions	filter(DBObject filter) Sets the selection query to determine the subset of documents from which to retrieve the distinct values.
Collation	getCollation() Returns the collation options
DBObject	getFilter() Gets the selection query to determine the subset of documents from which to retrieve the distinct values
ReadConcern	getReadConcern() Returns the readConcern
ReadPreference	getReadPreference() Returns the readPreference
DBCollectionDistinctOptions	readConcern(ReadConcern readConcern) Sets the readConcern
DBCollectionDistinctOptions	readPreference(ReadPreference readPreference) Sets the readPreference

Methods inherited from class java.lang.Object

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

Constructor Detail

DBCollectionDistinctOptions

public DBCollectionDistinctOptions()

Construct a new instance

Method Detail

getFilter

@Nullable
public DBObject getFilter()

Gets the selection query to determine the subset of documents from which to retrieve the distinct values

Returns:

the query

filter

public DBCollectionDistinctOptions filter(@Nullable
                                          DBObject filter)

Sets the selection query to determine the subset of documents from which to retrieve the distinct values.

Parameters:

filter - the selection query to determine the subset of documents from which to retrieve the distinct values

Returns:

this

getReadPreference

@Nullable
public ReadPreference getReadPreference()

Returns the readPreference

Returns:

the readPreference

readPreference

public DBCollectionDistinctOptions readPreference(@Nullable
                                                  ReadPreference readPreference)

Sets the readPreference

Parameters:

readPreference - the readPreference

Returns:

this

getReadConcern

@Nullable
public ReadConcern getReadConcern()

Returns the readConcern

Returns:

the readConcern

readConcern

public DBCollectionDistinctOptions readConcern(@Nullable
                                               ReadConcern readConcern)

Sets the readConcern

Parameters:

readConcern - the readConcern

Returns:

this

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

collation

public DBCollectionDistinctOptions collation(@Nullable
                                             Collation collation)

Sets the collation

Parameters:

collation - the collation

Returns:

this