NodeGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticache.model.NodeGroup

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NodeGroup
extends Object
implements Serializable, Cloneable
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NodeGroup()

Constructors
Constructor and Description
`NodeGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getNodeGroupId()` The identifier for the node group (shard).
`List<NodeGroupMember>`	`getNodeGroupMembers()` A list containing information about individual nodes within the node group (shard).
`Endpoint`	`getPrimaryEndpoint()` The endpoint of the primary node in this node group (shard).
`String`	`getSlots()` The keyspace for this node group (shard).
`String`	`getStatus()` The current state of this replication group - `creating`, `available`, etc.
`int`	`hashCode()`
`void`	`setNodeGroupId(String nodeGroupId)` The identifier for the node group (shard).
`void`	`setNodeGroupMembers(Collection<NodeGroupMember> nodeGroupMembers)` A list containing information about individual nodes within the node group (shard).
`void`	`setPrimaryEndpoint(Endpoint primaryEndpoint)` The endpoint of the primary node in this node group (shard).
`void`	`setSlots(String slots)` The keyspace for this node group (shard).
`void`	`setStatus(String status)` The current state of this replication group - `creating`, `available`, etc.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`NodeGroup`	`withNodeGroupId(String nodeGroupId)` The identifier for the node group (shard).
`NodeGroup`	`withNodeGroupMembers(Collection<NodeGroupMember> nodeGroupMembers)` A list containing information about individual nodes within the node group (shard).
`NodeGroup`	`withNodeGroupMembers(NodeGroupMember... nodeGroupMembers)` A list containing information about individual nodes within the node group (shard).
`NodeGroup`	`withPrimaryEndpoint(Endpoint primaryEndpoint)` The endpoint of the primary node in this node group (shard).
`NodeGroup`	`withSlots(String slots)` The keyspace for this node group (shard).
`NodeGroup`	`withStatus(String status)` The current state of this replication group - `creating`, `available`, etc.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NodeGroup
```
public NodeGroup()
```
- Method Detail
  - setNodeGroupId
```
public void setNodeGroupId(String nodeGroupId)
```
    The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
    
    Parameters:
    
    nodeGroupId - The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
  - getNodeGroupId
```
public String getNodeGroupId()
```
    The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
    
    Returns:
    
    The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
  - withNodeGroupId
```
public NodeGroup withNodeGroupId(String nodeGroupId)
```
    The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
    
    Parameters:
    
    nodeGroupId - The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 15 node groups numbered 0001 to 0015.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current state of this replication group - creating, available, etc.
    
    Parameters:
    
    status - The current state of this replication group - creating, available, etc.
  - getStatus
```
public String getStatus()
```
    The current state of this replication group - creating, available, etc.
    
    Returns:
    
    The current state of this replication group - creating, available, etc.
  - withStatus
```
public NodeGroup withStatus(String status)
```
    The current state of this replication group - creating, available, etc.
    
    Parameters:
    
    status - The current state of this replication group - creating, available, etc.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrimaryEndpoint
```
public void setPrimaryEndpoint(Endpoint primaryEndpoint)
```
    The endpoint of the primary node in this node group (shard).
    
    Parameters:
    
    primaryEndpoint - The endpoint of the primary node in this node group (shard).
  - getPrimaryEndpoint
```
public Endpoint getPrimaryEndpoint()
```
    The endpoint of the primary node in this node group (shard).
    
    Returns:
    
    The endpoint of the primary node in this node group (shard).
  - withPrimaryEndpoint
```
public NodeGroup withPrimaryEndpoint(Endpoint primaryEndpoint)
```
    The endpoint of the primary node in this node group (shard).
    
    Parameters:
    
    primaryEndpoint - The endpoint of the primary node in this node group (shard).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSlots
```
public void setSlots(String slots)
```
    The keyspace for this node group (shard).
    
    Parameters:
    
    slots - The keyspace for this node group (shard).
  - getSlots
```
public String getSlots()
```
    The keyspace for this node group (shard).
    
    Returns:
    
    The keyspace for this node group (shard).
  - withSlots
```
public NodeGroup withSlots(String slots)
```
    The keyspace for this node group (shard).
    
    Parameters:
    
    slots - The keyspace for this node group (shard).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNodeGroupMembers
```
public List<NodeGroupMember> getNodeGroupMembers()
```
    A list containing information about individual nodes within the node group (shard).
    
    Returns:
    
    A list containing information about individual nodes within the node group (shard).
  - setNodeGroupMembers
```
public void setNodeGroupMembers(Collection<NodeGroupMember> nodeGroupMembers)
```
    A list containing information about individual nodes within the node group (shard).
    
    Parameters:
    
    nodeGroupMembers - A list containing information about individual nodes within the node group (shard).
  - withNodeGroupMembers
```
public NodeGroup withNodeGroupMembers(NodeGroupMember... nodeGroupMembers)
```
    A list containing information about individual nodes within the node group (shard).
    
    NOTE: This method appends the values to the existing list (if any). Use setNodeGroupMembers(java.util.Collection) or withNodeGroupMembers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    nodeGroupMembers - A list containing information about individual nodes within the node group (shard).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNodeGroupMembers
```
public NodeGroup withNodeGroupMembers(Collection<NodeGroupMember> nodeGroupMembers)
```
    A list containing information about individual nodes within the node group (shard).
    
    Parameters:
    
    nodeGroupMembers - A list containing information about individual nodes within the node group (shard).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NodeGroup clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class NodeGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NodeGroup

Method Detail

setNodeGroupId

getNodeGroupId

withNodeGroupId

setStatus

getStatus

withStatus

setPrimaryEndpoint

getPrimaryEndpoint

withPrimaryEndpoint

setSlots

getSlots

withSlots

getNodeGroupMembers

setNodeGroupMembers

withNodeGroupMembers

withNodeGroupMembers

toString

equals

hashCode

clone