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>

Public NotInheritable Class ReadPreference
	Implements IEquatable(Of ReadPreference)

[<SealedAttribute>]
type ReadPreference =  
    class
        interface IEquatable<ReadPreference>
    end

The ReadPreference type exposes the following members.

Constructors

	Name	Description
	ReadPreference	Initializes a new instance of the ReadPreference class.

Properties

	Name	Description
	Hedge	Gets the hedge.
	MaxStaleness	Gets the maximum staleness.
	Nearest	Gets an instance of ReadPreference that represents a Nearest read preference.
	Primary	Gets an instance of ReadPreference that represents a Primary read preference.
	PrimaryPreferred	Gets an instance of ReadPreference that represents a PrimaryPreferred read preference.
	ReadPreferenceMode	Gets the read preference mode.
	Secondary	Gets an instance of ReadPreference that represents a Secondary read preference.
	SecondaryPreferred	Gets an instance of ReadPreference that represents a SecondaryPreferred read preference.
	TagSets	Gets the tag sets.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).)
	Equals(ReadPreference)	Indicates whether the current object is equal to another object of the same type.
	FromBsonDocument	Creates a new ReadPreference instance from a BsonDocument.
	GetHashCode	Serves as the default hash function. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)
	With(NullableTimeSpan)	Returns a new instance of ReadPreference with some values changed.
	With(ReadPreferenceHedge)	Returns a new instance of ReadPreference with some values changed.
	With(ReadPreferenceMode)	Returns a new instance of ReadPreference with some values changed.
	With(IEnumerableTagSet)	Returns a new instance of ReadPreference with some values changed.

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	Serializes an object to a JSON string. (Defined by BsonExtensionMethods.)