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

Class User

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

  • Method Details

    • userId

      public final String userId()

      The ID of the user.

      Returns:
      The ID of the user.

    • userName

      public final String userName()

      The username of the user.

      Returns:
      The username of the user.

    • status

      public final String status()

      Indicates the user status. Can be "active", "modifying" or "deleting".

      Returns:
      Indicates the user status. Can be "active", "modifying" or "deleting".

    • engine

      public final String engine()

      The current supported value is Redis.

      Returns:
      The current supported value is Redis.

    • minimumEngineVersion

      public final String minimumEngineVersion()

      The minimum engine version required, which is Redis OSS 6.0

      Returns:
      The minimum engine version required, which is Redis OSS 6.0

    • accessString

      public final String accessString()

      Access permissions string used for this user.

      Returns:
      Access permissions string used for this user.

    • hasUserGroupIds

      public final boolean hasUserGroupIds()
      For responses, this returns true if the service returned a value for the UserGroupIds 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.

    • userGroupIds

      public final List<String> userGroupIds()

      Returns a list of the user group IDs the user belongs to.

      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 hasUserGroupIds() method.

      Returns:
      Returns a list of the user group IDs the user belongs to.

    • authentication

      public final Authentication authentication()

      Denotes whether the user requires a password to authenticate.

      Returns:
      Denotes whether the user requires a password to authenticate.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the user.

      Returns:
      The Amazon Resource Name (ARN) of the user.

    • toBuilder

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

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

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