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

Class ModifyUserGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticache.model.ElastiCacheRequest

software.amazon.awssdk.services.elasticache.model.ModifyUserGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ModifyUserGroupRequest.Builder,ModifyUserGroupRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ModifyUserGroupRequest
extends ElastiCacheRequest
implements ToCopyableBuilder<ModifyUserGroupRequest.Builder,ModifyUserGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ModifyUserGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ModifyUserGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUserIdsToAdd()	For responses, this returns true if the service returned a value for the UserIdsToAdd property.
boolean	hasUserIdsToRemove()	For responses, this returns true if the service returned a value for the UserIdsToRemove property.
List<SdkField<?>>	sdkFields()
static Class<? extends ModifyUserGroupRequest.Builder>	serializableBuilderClass()
ModifyUserGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userGroupId()	The ID of the user group.
List<String>	userIdsToAdd()	The list of user IDs to add to the user group.
List<String>	userIdsToRemove()	The list of user IDs to remove from the user group.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

userGroupId

public final String userGroupId()

The ID of the user group.

Returns:

The ID of the user group.

hasUserIdsToAdd

public final boolean hasUserIdsToAdd()

For responses, this returns true if the service returned a value for the UserIdsToAdd 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.

userIdsToAdd

public final List<String> userIdsToAdd()

The list of user IDs to add 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 hasUserIdsToAdd() method.

Returns:

The list of user IDs to add to the user group.

hasUserIdsToRemove

public final boolean hasUserIdsToRemove()

For responses, this returns true if the service returned a value for the UserIdsToRemove 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.

userIdsToRemove

public final List<String> userIdsToRemove()

The list of user IDs to remove from 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 hasUserIdsToRemove() method.

Returns:

The list of user IDs to remove from the user group.

toBuilder

public ModifyUserGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyUserGroupRequest.Builder,ModifyUserGroupRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static ModifyUserGroupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo