Class UserGroup

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

  • Method Details

    • userGroupId

      public final String userGroupId()

      The ID of the user group.

      Returns:
      The ID of the user group.

    • status

      public final String status()

      Indicates user group status. Can be "creating", "active", "modifying", "deleting".

      Returns:
      Indicates user group status. Can be "creating", "active", "modifying", "deleting".

    • engine

      public final String engine()

      The options are valkey or redis.

      Returns:
      The options are valkey or redis.

    • hasUserIds

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

    • userIds

      public final List<String> userIds()

      The list of user IDs that belong to the user group.

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

      Returns:
      The list of user IDs that belong to the user group.

    • 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

    • pendingChanges

      public final UserGroupPendingChanges pendingChanges()

      A list of updates being applied to the user group.

      Returns:
      A list of updates being applied to the user group.

    • hasReplicationGroups

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

    • replicationGroups

      public final List<String> replicationGroups()

      A list of replication groups that the user group can access.

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

      Returns:
      A list of replication groups that the user group can access.

    • hasServerlessCaches

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

    • serverlessCaches

      public final List<String> serverlessCaches()

      Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

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

      Returns:
      Indicates which serverless caches the specified user group is associated with. Available for Valkey, Redis OSS and Serverless Memcached only.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the user group.

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

    • toBuilder

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

    • builder

      public static UserGroup.Builder builder()

    • serializableBuilderClass

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