Click or drag to resize

ReadPreference Class

Represents a read preference.
Inheritance Hierarchy
SystemObject
  MongoDB.DriverReadPreference

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public sealed class ReadPreference : IEquatable<ReadPreference>

The ReadPreference type exposes the following members.

Constructors
  NameDescription
Public methodReadPreference
Initializes a new instance of the ReadPreference class.
Top
Properties
  NameDescription
Public propertyHedge
Gets the hedge.
Public propertyMaxStaleness
Gets the maximum staleness.
Public propertyStatic memberNearest
Gets an instance of ReadPreference that represents a Nearest read preference.
Public propertyStatic memberPrimary
Gets an instance of ReadPreference that represents a Primary read preference.
Public propertyStatic memberPrimaryPreferred
Gets an instance of ReadPreference that represents a PrimaryPreferred read preference.
Public propertyReadPreferenceMode
Gets the read preference mode.
Public propertyStatic memberSecondary
Gets an instance of ReadPreference that represents a Secondary read preference.
Public propertyStatic memberSecondaryPreferred
Gets an instance of ReadPreference that represents a SecondaryPreferred read preference.
Public propertyTagSets
Gets the tag sets.
Top
Methods
  NameDescription
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(ReadPreference)
Indicates whether the current object is equal to another object of the same type.
Public methodStatic memberFromBsonDocument
Creates a new ReadPreference instance from a BsonDocument.
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Overrides ObjectToString.)
Public methodWith(NullableTimeSpan)
Returns a new instance of ReadPreference with some values changed.
Public methodWith(ReadPreferenceHedge)
Returns a new instance of ReadPreference with some values changed.
Public methodWith(ReadPreferenceMode)
Returns a new instance of ReadPreference with some values changed.
Public methodWith(IEnumerableTagSet)
Returns a new instance of ReadPreference with some values changed.
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
See Also