ClusterDescription (mongo-java-driver 3.3.0-query-log-max-size API)

java.lang.Object
- com.mongodb.connection.ClusterDescription

@Immutable
public class ClusterDescription
extends java.lang.Object

Immutable snapshot state of a cluster.

从以下版本开始:: 3.0

构造器概要

构造器
构造器和说明
`ClusterDescription(ClusterConnectionMode connectionMode, ClusterType type, java.util.List<ServerDescription> serverDescriptions)` Creates a new ClusterDescription.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`boolean`	`equals(java.lang.Object o)`
`java.util.Set<ServerDescription>`	`getAll()` 已过时。 Use `getServerDescriptions()` instead
`java.util.List<ServerDescription>`	`getAny()` 已过时。 Replace with a filter on ServerDescription in the caller
`java.util.List<ServerDescription>`	`getAnyPrimaryOrSecondary()` 已过时。 Replace with a filter on ServerDescription in the caller
`java.util.List<ServerDescription>`	`getAnyPrimaryOrSecondary(TagSet tagSet)` 已过时。 Replace with a filter on ServerDescription in the caller
`ServerDescription`	`getByServerAddress(ServerAddress serverAddress)` 已过时。 Replace with a filter on ServerDescription in the caller
`ClusterConnectionMode`	`getConnectionMode()` Gets whether this cluster is connecting to a single server or multiple servers.
`java.util.List<ServerDescription>`	`getPrimaries()` 已过时。 Replace with a filter on ServerDescription in the caller
`java.util.List<ServerDescription>`	`getSecondaries()` 已过时。 Replace with a filter on ServerDescription in the caller
`java.util.List<ServerDescription>`	`getSecondaries(TagSet tagSet)` 已过时。 Replace with a filter on ServerDescription in the caller
`java.util.List<ServerDescription>`	`getServerDescriptions()` Returns an unmodifiable list of the server descriptions in this cluster description.
`java.lang.String`	`getShortDescription()` Returns a short, pretty description for this ClusterDescription.
`ClusterType`	`getType()` Gets the specific type of this cluster
`int`	`hashCode()`
`boolean`	`hasReadableServer(ReadPreference readPreference)` Returns true if this cluster has at least one server that satisfies the given read preference.
`boolean`	`hasWritableServer()` Returns true if this cluster has at least one server that can be used for write operations.
`boolean`	`isCompatibleWithDriver()` Return whether the cluster is compatible with the driver.
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - ClusterDescription
```
public ClusterDescription(ClusterConnectionMode connectionMode,
                          ClusterType type,
                          java.util.List<ServerDescription> serverDescriptions)
```
    Creates a new ClusterDescription.
    
    参数:
    
    connectionMode - whether to connect directly to a single server or to multiple servers
    
    type - what sort of cluster this is
    
    serverDescriptions - the descriptions of all the servers currently in this cluster
- 方法详细资料
  - isCompatibleWithDriver
```
public boolean isCompatibleWithDriver()
```
    Return whether the cluster is compatible with the driver.
    
    返回:
    
    true if the cluster is compatible with the driver.
  - hasReadableServer
```
public boolean hasReadableServer(ReadPreference readPreference)
```
    Returns true if this cluster has at least one server that satisfies the given read preference.
    
    参数:
    
    readPreference - the non-null read preference
    
    返回:
    
    whether this cluster has at least one server that satisfies the given read preference
    
    从以下版本开始:
    
    3.3
  - hasWritableServer
```
public boolean hasWritableServer()
```
    Returns true if this cluster has at least one server that can be used for write operations.
    
    返回:
    
    true if this cluster has at least one server that can be used for write operations
    
    从以下版本开始:
    
    3.3
  - getConnectionMode
```
public ClusterConnectionMode getConnectionMode()
```
    Gets whether this cluster is connecting to a single server or multiple servers.
    
    返回:
    
    the ClusterConnectionMode for this cluster
  - getType
```
public ClusterType getType()
```
    Gets the specific type of this cluster
    
    返回:
    
    a ClusterType enum representing the type of this cluster
  - getServerDescriptions
```
public java.util.List<ServerDescription> getServerDescriptions()
```
    Returns an unmodifiable list of the server descriptions in this cluster description.
    
    返回:
    
    an unmodifiable list of the server descriptions in this cluster description
    
    从以下版本开始:
    
    3.3
  - getAll
```
@Deprecated
public java.util.Set<ServerDescription> getAll()
```
    已过时。 Use getServerDescriptions() instead
    
    Returns the Set of all server descriptions in this cluster, sorted by the String value of the ServerAddress of each one.
    
    返回:
    
    the set of server descriptions
  - getByServerAddress
```
@Deprecated
public ServerDescription getByServerAddress(ServerAddress serverAddress)
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Returns the ServerDescription for the server at the given address
    
    参数:
    
    serverAddress - the ServerAddress for a server in this cluster
    
    返回:
    
    the ServerDescription for this server
  - getPrimaries
```
@Deprecated
public java.util.List<ServerDescription> getPrimaries()
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    While it may seem counter-intuitive that a MongoDB cluster can have more than one primary, it can in the case where the client's view of the cluster is a set of mongos servers, any of which can serve as the primary.
    
    返回:
    
    a list of servers that can act as primaries
  - getSecondaries
```
@Deprecated
public java.util.List<ServerDescription> getSecondaries()
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Get a list of all the secondaries in this cluster
    
    返回:
    
    a List of ServerDescriptions of all the secondaries this cluster is currently aware of
  - getSecondaries
```
@Deprecated
public java.util.List<ServerDescription> getSecondaries(TagSet tagSet)
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Get a list of all the secondaries in this cluster that match a given TagSet
    
    参数:
    
    tagSet - a Set of replica set tags
    
    返回:
    
    a List of ServerDescriptions of all the secondaries this cluster that match all of the given tags
  - getAny
```
@Deprecated
public java.util.List<ServerDescription> getAny()
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Gets a list of ServerDescriptions for all the servers in this cluster which are currently accessible.
    
    返回:
    
    a List of ServerDescriptions for all servers that have a status of OK
  - getAnyPrimaryOrSecondary
```
@Deprecated
public java.util.List<ServerDescription> getAnyPrimaryOrSecondary()
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Gets a list of all the primaries and secondaries in this cluster.
    
    返回:
    
    a list of ServerDescriptions for all primary and secondary servers
  - getAnyPrimaryOrSecondary
```
@Deprecated
public java.util.List<ServerDescription> getAnyPrimaryOrSecondary(TagSet tagSet)
```
    已过时。 Replace with a filter on ServerDescription in the caller
    
    Gets a list of all the primaries and secondaries in this cluster that match the given replica set tags.
    
    参数:
    
    tagSet - a Set of replica set tags
    
    返回:
    
    a list of ServerDescriptions for all primary and secondary servers that contain all of the given tags
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Returns a short, pretty description for this ClusterDescription.
    
    返回:
    
    a String describing this cluster.

类 ClusterDescription

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ClusterDescription

方法详细资料

isCompatibleWithDriver

hasReadableServer

hasWritableServer

getConnectionMode

getType

getServerDescriptions

getAll

getByServerAddress

getPrimaries

getSecondaries

getSecondaries

getAny

getAnyPrimaryOrSecondary

getAnyPrimaryOrSecondary

equals

hashCode

toString

getShortDescription