Struct ClusterNodeResult

pub struct ClusterNodeResult {
    pub id: String,
    pub endpoint: String,
    pub ip: String,
    pub port: Option<u16>,
    pub hostname: Option<String>,
    pub tls_port: Option<u16>,
    pub role: String,
    pub replication_offset: usize,
    pub health: ClusterHealthStatus,
}

Cluster node result for the cluster_shards command.

Fields

id: String

The unique node id for this particular node.

endpoint: String

The preferred endpoint to reach the node

ip: String

The IP address to send requests to for this node.

port: Option<u16>

The TCP (non-TLS) port of the node. At least one of port or tls-port will be present.

hostname: Option<String>

The announced hostname to send requests to for this node.

tls_port: Option<u16>

The TLS port of the node. At least one of port or tls-port will be present.

role: String

The replication role of this node.

replication_offset: usize

The replication offset of this node. This information can be used to send commands to the most up to date replicas.

health: ClusterHealthStatus

Either online, failed, or loading. This information should be used to determine which nodes should be sent traffic. The loading health state should be used to know that a node is not currently eligible to serve traffic, but may be eligible in the future.

Trait Implementations

impl Debug for ClusterNodeResult

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClusterNodeResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.