software.amazon.awssdk.services.cognitoidentityprovider.model

Class ListUserPoolsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsRequest

All Implemented Interfaces:

ToCopyableBuilder<ListUserPoolsRequest.Builder,ListUserPoolsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class ListUserPoolsRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<ListUserPoolsRequest.Builder,ListUserPoolsRequest>

Represents the request to list user pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListUserPoolsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListUserPoolsRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of results you want the request to return when listing the user pools.
String	nextToken() An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
static Class<? extends ListUserPoolsRequest.Builder>	serializableBuilderClass()
ListUserPoolsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nextToken

public String nextToken()

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Returns:

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

maxResults

public Integer maxResults()

The maximum number of results you want the request to return when listing the user pools.

Returns:

The maximum number of results you want the request to return when listing the user pools.

toBuilder

public ListUserPoolsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListUserPoolsRequest.Builder,ListUserPoolsRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

Returns:

a builder for type T

builder

public static ListUserPoolsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value