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

Class DescribeUsersRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeUsersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeUsersRequest.Builder	builder()
String	engine()	The engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	Filter to determine the list of User IDs to return.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
String	marker()	An optional marker returned from a prior request.
Integer	maxRecords()	The maximum number of records to include in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUsersRequest.Builder>	serializableBuilderClass()
DescribeUsersRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userId()	The ID of the user.

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

engine

public final String engine()

The engine.

Returns:

The engine.

userId

public final String userId()

The ID of the user.

Returns:

The ID of the user.

hasFilters

public final boolean hasFilters()

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

filters

public final List<Filter> filters()

Filter to determine the list of User IDs to return.

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

Returns:

Filter to determine the list of User IDs to return.

maxRecords

public final Integer maxRecords()

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Returns:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

marker

public final String marker()

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

Returns:

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. >

toBuilder

public DescribeUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Specified by:

toBuilder in class ElastiCacheRequest

builder

public static DescribeUsersRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo