Class NodeGroupMember

java.lang.Object
software.amazon.awssdk.services.elasticache.model.NodeGroupMember
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NodeGroupMember.Builder,NodeGroupMember>
@Generated("software.amazon.awssdk:codegen") public final class NodeGroupMember extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NodeGroupMember.Builder,NodeGroupMember>

Represents a single node within a node group (shard).

See Also:

  • Method Details

    • cacheClusterId

      public final String cacheClusterId()

      The ID of the cluster to which the node belongs.

      Returns:
      The ID of the cluster to which the node belongs.

    • cacheNodeId

      public final String cacheNodeId()

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

    • readEndpoint

      public final Endpoint readEndpoint()

      The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Valkey or Redis OSS (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 Valkey or Redis OSS (cluster mode disabled) clusters.

    • preferredAvailabilityZone

      public final String preferredAvailabilityZone()

      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.

    • preferredOutpostArn

      public final String preferredOutpostArn()

      The outpost ARN of the node group member.

      Returns:
      The outpost ARN of the node group member.

    • currentRole

      public final String currentRole()

      The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

      Returns:
      The role that is currently assigned to the node - primary or replica. This member is only applicable for Valkey or Redis OSS (cluster mode disabled) replication groups.

    • toBuilder

      public NodeGroupMember.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<NodeGroupMember.Builder,NodeGroupMember>
      Returns:
      a builder for type T

    • builder

      public static NodeGroupMember.Builder builder()

    • serializableBuilderClass

      public static Class<? extends NodeGroupMember.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.