software.amazon.awssdk.services.cognitoidentityprovider.model

Class ListUserPoolsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.ListUserPoolsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUserPoolsResponse.Builder,ListUserPoolsResponse>

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

Represents the response to list user pools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListUserPoolsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListUserPoolsResponse.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 SdkResponse.
int	hashCode()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUserPoolsResponse.Builder>	serializableBuilderClass()
ListUserPoolsResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<UserPoolDescriptionType>	userPools() The user pools from the response to list users.

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

userPools

public List<UserPoolDescriptionType> userPools()

The user pools from the response to list users.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The user pools from the response to list users.

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.

toBuilder

public ListUserPoolsResponse.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<ListUserPoolsResponse.Builder,ListUserPoolsResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ListUserPoolsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListUserPoolsResponse.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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.