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

Interface DescribeUsersRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>, MemoryDbRequest.Builder, SdkBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeUsersRequest

public static interface DescribeUsersRequest.Builder
extends MemoryDbRequest.Builder, SdkPojo, CopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

Method Summary

Modifier and Type	Method	Description
DescribeUsersRequest.Builder	filters(Collection<Filter> filters)	Filter to determine the list of users to return.
DescribeUsersRequest.Builder	filters(Consumer<Filter.Builder>... filters)	Filter to determine the list of users to return.
DescribeUsersRequest.Builder	filters(Filter... filters)	Filter to determine the list of users to return.
DescribeUsersRequest.Builder	maxResults(Integer maxResults)	The maximum number of records to include in the response.
DescribeUsersRequest.Builder	nextToken(String nextToken)	An optional argument to pass in case the total number of records exceeds the value of MaxResults.
DescribeUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeUsersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeUsersRequest.Builder	userName(String userName)	The name of the user.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.memorydb.model.MemoryDbRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

userName

DescribeUsersRequest.Builder userName(String userName)

The name of the user.

Parameters:

userName - The name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeUsersRequest.Builder filters(Collection<Filter> filters)

Filter to determine the list of users to return.

Parameters:

filters - Filter to determine the list of users to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeUsersRequest.Builder filters(Filter... filters)

Filter to determine the list of users to return.

Parameters:

filters - Filter to determine the list of users to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribeUsersRequest.Builder filters(Consumer<Filter.Builder>... filters)

Filter to determine the list of users to return.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(java.util.Collection)

maxResults

DescribeUsersRequest.Builder maxResults(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

nextToken

DescribeUsersRequest.Builder nextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DescribeUsersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeUsersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder