com.mongodb

Class TaggableReadPreference

java.lang.Object

com.mongodb.ReadPreference

com.mongodb.TaggableReadPreference

@Immutable
public abstract class TaggableReadPreference
extends ReadPreference

Abstract class for all preference which can be combined with tags

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Long	getMaxStaleness(java.util.concurrent.TimeUnit timeUnit) Gets the maximum acceptable staleness of a secondary in order to be considered for read operations.
java.util.List<TagSet>	getTagSetList() Gets the list of tag sets as a list of TagSet instances.
int	hashCode()
boolean	isSlaveOk() True if this read preference allows reading from a secondary member of a replica set.
BsonDocument	toDocument() Gets a document representing this read preference in the wire protocol.
java.lang.String	toString()

Methods inherited from class com.mongodb.ReadPreference

choose, getName, nearest, nearest, nearest, nearest, nearest, nearest, primary, primaryPreferred, primaryPreferred, primaryPreferred, primaryPreferred, primaryPreferred, primaryPreferred, secondary, secondary, secondary, secondary, secondary, secondary, secondaryPreferred, secondaryPreferred, secondaryPreferred, secondaryPreferred, secondaryPreferred, secondaryPreferred, valueOf, valueOf, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

isSlaveOk

public boolean isSlaveOk()

Description copied from class: ReadPreference

True if this read preference allows reading from a secondary member of a replica set.

Specified by:

isSlaveOk in class ReadPreference

Returns:

if reading from a secondary is ok

toDocument

public BsonDocument toDocument()

Description copied from class: ReadPreference

Gets a document representing this read preference in the wire protocol.

Specified by:

toDocument in class ReadPreference

Returns:

the document

getTagSetList

public java.util.List<TagSet> getTagSetList()

Gets the list of tag sets as a list of TagSet instances.

Returns:

the list of tag sets

Since:

2.13

getMaxStaleness

@Nullable
public java.lang.Long getMaxStaleness(java.util.concurrent.TimeUnit timeUnit)

Gets the maximum acceptable staleness of a secondary in order to be considered for read operations.

The maximum staleness feature is designed to prevent badly-lagging servers from being selected. The staleness estimate is imprecise and shouldn't be used to try to select "up-to-date" secondaries.

The driver estimates the staleness of each secondary, based on lastWriteDate values provided in server isMaster responses, and selects only those secondaries whose staleness is less than or equal to maxStaleness.

Parameters:

timeUnit - the time unit in which to return the value

Returns:

the maximum acceptable staleness in the given time unit, or null if the value is not set

Since:

3.4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object