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

Class CreateUserGroupRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserGroupRequest.Builder,CreateUserGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateUserGroupRequest.Builder	builder()
String	engine()	The current supported value is Redis user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
boolean	hasUserIds()	For responses, this returns true if the service returned a value for the UserIds property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to be added to this resource.
CreateUserGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userGroupId()	The ID of the user group.
List<String>	userIds()	The list of user IDs that belong to 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.

engine

public final String engine()

The current supported value is Redis user.

Returns:

The current supported value is Redis user.

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.

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis OSS 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 hasTags() method.

Returns:

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted. Available for Redis OSS only.

toBuilder

public CreateUserGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserGroupRequest.Builder,CreateUserGroupRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static CreateUserGroupRequest.Builder builder()

serializableBuilderClass

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