ClusterDescription Class |
Represents information about a cluster.
Inheritance HierarchyNamespace: MongoDB.Driver.Core.Clusters
Assembly: MongoDB.Driver.Core (in MongoDB.Driver.Core.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
SyntaxThe ClusterDescription type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClusterDescription(ClusterId, ClusterConnectionMode, ClusterType, IEnumerableServerDescription) | Obsolete.
Initializes a new instance of the ClusterDescription class.
|
| ClusterDescription(ClusterId, ClusterConnectionMode, Exception, ClusterType, IEnumerableServerDescription) | Obsolete.
Initializes a new instance of the ClusterDescription class.
|
| ClusterDescription(ClusterId, NullableBoolean, Exception, ClusterType, IEnumerableServerDescription) |
Initializes a new instance of the ClusterDescription class.
|
Properties| Name | Description | |
|---|---|---|
 | ClusterId |
Gets the cluster identifier.
|
| ConnectionMode | Obsolete.
Gets the connection mode.
|
| ConnectionModeSwitch | Obsolete.
Gets the connection mode switch.
|
| DirectConnection |
Gets the DirectConnection.
|
| DnsMonitorException |
Gets the last DNS monitor exception (null if there was none).
|
| IsCompatibleWithDriver |
Gets a value indicating whether this cluster is compatible with the driver.
|
| IsDirectConnection |
Gets whether the connection mode or the direct connection flag are configured as a direct connection.
|
| LogicalSessionTimeout |
Gets the logical session timeout.
|
| Servers |
Gets the servers.
|
| State |
Gets the cluster state.
|
| Type |
Gets the cluster type.
|
Methods| Name | Description | |
|---|---|---|
| Equals(ClusterDescription) | Indicates whether the current object is equal to another object of the same type. |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object).) |
| 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.) |
| WithDnsMonitorException |
Returns a new ClusterDescription with a changed DnsMonitorException.
|
| WithoutServerDescription |
Returns a new ClusterDescription with a ServerDescription removed.
|
| WithServerDescription |
Returns a new ClusterDescription with a changed ServerDescription.
|
| WithType |
Returns a new ClusterDescription with a changed ClusterType.
|
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.) |
See Also