NodeGroup

class NodeGroup

Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

Link copied to clipboard

A list containing information about individual nodes within the node group (shard).

Link copied to clipboard

The endpoint of the primary node in this node group (shard).

Link copied to clipboard

The endpoint of the replica nodes in this node group (shard). This value is read-only.

Link copied to clipboard

The keyspace for this node group (shard).

Link copied to clipboard

The current state of this replication group - creating, available, modifying, deleting.

Functions

Link copied to clipboard
inline fun copy(block: NodeGroup.Builder.() -> Unit = {}): NodeGroup
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String