Package software.amazon.awssdk.services.elasticache.model

Class NodeGroup

java.lang.Object

software.amazon.awssdk.services.elasticache.model.NodeGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NodeGroup.Builder,NodeGroup>

@Generated("software.amazon.awssdk:codegen")
public final class NodeGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NodeGroup.Builder,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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NodeGroup.Builder

Method Summary

Modifier and Type	Method	Description
static NodeGroup.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNodeGroupMembers()	For responses, this returns true if the service returned a value for the NodeGroupMembers property.
String	nodeGroupId()	The identifier for the node group (shard).
List<NodeGroupMember>	nodeGroupMembers()	A list containing information about individual nodes within the node group (shard).
Endpoint	primaryEndpoint()	The endpoint of the primary node in this node group (shard).
Endpoint	readerEndpoint()	The endpoint of the replica nodes in this node group (shard).
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends NodeGroup.Builder>	serializableBuilderClass()
String	slots()	The keyspace for this node group (shard).
String	status()	The current state of this replication group - creating, available, modifying, deleting.
NodeGroup.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

nodeGroupId

public final String nodeGroupId()

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.

Returns:

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.

status

public final String status()

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

Returns:

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

primaryEndpoint

public final Endpoint primaryEndpoint()

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

Returns:

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

readerEndpoint

public final Endpoint readerEndpoint()

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

Returns:

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

slots

public final String slots()

The keyspace for this node group (shard).

Returns:

The keyspace for this node group (shard).

hasNodeGroupMembers

public final boolean hasNodeGroupMembers()

For responses, this returns true if the service returned a value for the NodeGroupMembers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

nodeGroupMembers

public final List<NodeGroupMember> nodeGroupMembers()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNodeGroupMembers() method.

Returns:

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

toBuilder

public NodeGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NodeGroup.Builder,NodeGroup>

builder

public static NodeGroup.Builder builder()

serializableBuilderClass

public static Class<? extends NodeGroup.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo