Package software.amazon.awssdk.services.memorydb.model

Class DescribeUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.memorydb.model.MemoryDbRequest

software.amazon.awssdk.services.memorydb.model.DescribeUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeUsersRequest
extends MemoryDbRequest
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()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	Filter to determine the list of users 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()
Integer	maxResults()	The maximum number of records to include in the response.
String	nextToken()	An optional argument to pass in case the total number of records exceeds the value of MaxResults.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUsersRequest.Builder>	serializableBuilderClass()
DescribeUsersRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The name 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

userName

public final String userName()

The name of the user

Returns:

The name 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 users 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 users to return.

maxResults

public final Integer maxResults()

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token 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 MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken

public final String nextToken()

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Returns:

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

toBuilder

public DescribeUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Specified by:

toBuilder in class MemoryDbRequest

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