Click or drag to resize

ClusterDescription Class

Represents information about a cluster.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.Core.ClustersClusterDescription

Namespace:  MongoDB.Driver.Core.Clusters
Assembly:  MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax
public sealed class ClusterDescription : IEquatable<ClusterDescription>

The ClusterDescription type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyClusterId
Gets the cluster identifier.
Public propertyConnectionMode Obsolete.
Gets the connection mode.
Public propertyConnectionModeSwitch Obsolete.
Gets the connection mode switch.
Public propertyDirectConnection
Gets the DirectConnection.
Public propertyDnsMonitorException
Gets the last DNS monitor exception (null if there was none).
Public propertyIsCompatibleWithDriver
Gets a value indicating whether this cluster is compatible with the driver.
Public propertyIsDirectConnection
Gets whether the connection mode or the direct connection flag are configured as a direct connection.
Public propertyLogicalSessionTimeout
Gets the logical session timeout.
Public propertyServers
Gets the servers.
Public propertyState
Gets the cluster state.
Public propertyType
Gets the cluster type.
Top
Methods
  NameDescription
Public methodEquals(ClusterDescription)
Indicates whether the current object is equal to another object of the same type.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
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 methodWithDnsMonitorException
Returns a new ClusterDescription with a changed DnsMonitorException.
Public methodWithoutServerDescription
Returns a new ClusterDescription with a ServerDescription removed.
Public methodWithServerDescription
Returns a new ClusterDescription with a changed ServerDescription.
Public methodWithType
Returns a new ClusterDescription with a changed ClusterType.
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