NodeGroupMember (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NodeGroupMember
extends Object
implements Serializable, Cloneable
```
Represents a single node within a node group (shard).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NodeGroupMember()

Constructors
Constructor and Description
`NodeGroupMember()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NodeGroupMember`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCacheClusterId()` The ID of the cluster to which the node belongs.
`String`	`getCacheNodeId()` The ID of the node within its cluster.
`String`	`getCurrentRole()` The role that is currently assigned to the node - `primary` or `replica`.
`String`	`getPreferredAvailabilityZone()` The name of the Availability Zone in which the node is located.
`Endpoint`	`getReadEndpoint()` The information required for client programs to connect to a node for read operations.
`int`	`hashCode()`
`void`	`setCacheClusterId(String cacheClusterId)` The ID of the cluster to which the node belongs.
`void`	`setCacheNodeId(String cacheNodeId)` The ID of the node within its cluster.
`void`	`setCurrentRole(String currentRole)` The role that is currently assigned to the node - `primary` or `replica`.
`void`	`setPreferredAvailabilityZone(String preferredAvailabilityZone)` The name of the Availability Zone in which the node is located.
`void`	`setReadEndpoint(Endpoint readEndpoint)` The information required for client programs to connect to a node for read operations.
`String`	`toString()` Returns a string representation of this object.
`NodeGroupMember`	`withCacheClusterId(String cacheClusterId)` The ID of the cluster to which the node belongs.
`NodeGroupMember`	`withCacheNodeId(String cacheNodeId)` The ID of the node within its cluster.
`NodeGroupMember`	`withCurrentRole(String currentRole)` The role that is currently assigned to the node - `primary` or `replica`.
`NodeGroupMember`	`withPreferredAvailabilityZone(String preferredAvailabilityZone)` The name of the Availability Zone in which the node is located.
`NodeGroupMember`	`withReadEndpoint(Endpoint readEndpoint)` The information required for client programs to connect to a node for read operations.

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

- Constructor Detail
  - NodeGroupMember
```
public NodeGroupMember()
```
- Method Detail
  - setCacheClusterId
```
public void setCacheClusterId(String cacheClusterId)
```
    The ID of the cluster to which the node belongs.
    
    Parameters:
    
    cacheClusterId - The ID of the cluster to which the node belongs.
  - getCacheClusterId
```
public String getCacheClusterId()
```
    The ID of the cluster to which the node belongs.
    
    Returns:
    
    The ID of the cluster to which the node belongs.
  - withCacheClusterId
```
public NodeGroupMember withCacheClusterId(String cacheClusterId)
```
    The ID of the cluster to which the node belongs.
    
    Parameters:
    
    cacheClusterId - The ID of the cluster to which the node belongs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCacheNodeId
```
public void setCacheNodeId(String cacheNodeId)
```
    The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
    
    Parameters:
    
    cacheNodeId - The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
  - getCacheNodeId
```
public String getCacheNodeId()
```
    The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
    
    Returns:
    
    The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
  - withCacheNodeId
```
public NodeGroupMember withCacheNodeId(String cacheNodeId)
```
    The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
    
    Parameters:
    
    cacheNodeId - The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReadEndpoint
```
public void setReadEndpoint(Endpoint readEndpoint)
```
    The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
    
    Parameters:
    
    readEndpoint - The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
  - getReadEndpoint
```
public Endpoint getReadEndpoint()
```
    The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
    
    Returns:
    
    The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
  - withReadEndpoint
```
public NodeGroupMember withReadEndpoint(Endpoint readEndpoint)
```
    The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
    
    Parameters:
    
    readEndpoint - The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferredAvailabilityZone
```
public void setPreferredAvailabilityZone(String preferredAvailabilityZone)
```
    The name of the Availability Zone in which the node is located.
    
    Parameters:
    
    preferredAvailabilityZone - The name of the Availability Zone in which the node is located.
  - getPreferredAvailabilityZone
```
public String getPreferredAvailabilityZone()
```
    The name of the Availability Zone in which the node is located.
    
    Returns:
    
    The name of the Availability Zone in which the node is located.
  - withPreferredAvailabilityZone
```
public NodeGroupMember withPreferredAvailabilityZone(String preferredAvailabilityZone)
```
    The name of the Availability Zone in which the node is located.
    
    Parameters:
    
    preferredAvailabilityZone - The name of the Availability Zone in which the node is located.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentRole
```
public void setCurrentRole(String currentRole)
```
    The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
    
    Parameters:
    
    currentRole - The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
  - getCurrentRole
```
public String getCurrentRole()
```
    The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
    
    Returns:
    
    The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
  - withCurrentRole
```
public NodeGroupMember withCurrentRole(String currentRole)
```
    The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
    
    Parameters:
    
    currentRole - The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.
    
    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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 NodeGroupMember clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class NodeGroupMember

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NodeGroupMember

Method Detail

setCacheClusterId

getCacheClusterId

withCacheClusterId

setCacheNodeId

getCacheNodeId

withCacheNodeId

setReadEndpoint

getReadEndpoint

withReadEndpoint

setPreferredAvailabilityZone

getPreferredAvailabilityZone

withPreferredAvailabilityZone

setCurrentRole

getCurrentRole

withCurrentRole

toString

equals

hashCode

clone