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.6.0+Branch.origin/v2.6.x.Sha.593796a7b35dc59243383bcc684de296a5468f2e

Syntax

Copy

public sealed class ClusterDescription : IEquatable<ClusterDescription>

Public NotInheritable Class ClusterDescription
	Implements IEquatable(Of ClusterDescription)

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

The ClusterDescription type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ClusterId	Gets the cluster identifier.
	ConnectionMode	Gets the connection mode.
	IsCompatibleWithDriver	Gets a value indicating whether this cluster is compatible with the driver.
	LogicalSessionTimeout	Gets the logical session timeout.
	Servers	Gets the servers.
	State	Gets the cluster state.
	Type	Gets the cluster type.

Top

Methods

	Name	Description
	Equals(Object)	(Overrides ObjectEquals(Object).)
	Equals(ClusterDescription)
	GetHashCode	(Overrides ObjectGetHashCode.)
	GetType	(Inherited from Object.)
	ToString	(Overrides ObjectToString.)
	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.

Top

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.)

Top

Reference

MongoDB.Driver.Core.Clusters Namespace