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:

  • Method Details

    • nodeGroupId

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

      Returns:
      The endpoint of the replica nodes in this node group (shard).

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<NodeGroup.Builder,NodeGroup>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.