Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminListGroupsForUserRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminListGroupsForUserRequest.Builder,AdminListGroupsForUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminListGroupsForUserRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AdminListGroupsForUserRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of groups that you want Amazon Cognito to return in the response.
String	nextToken()	This API operation returns a limited number of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminListGroupsForUserRequest.Builder>	serializableBuilderClass()
AdminListGroupsForUserRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	The username of the user that you want to query or modify.
String	userPoolId()	The ID of the user pool where you want to view a user's groups.

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 username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

userPoolId

public final String userPoolId()

The ID of the user pool where you want to view a user's groups.

Returns:

The ID of the user pool where you want to view a user's groups.

limit

public final Integer limit()

The maximum number of groups that you want Amazon Cognito to return in the response.

Returns:

The maximum number of groups that you want Amazon Cognito to return in the response.

nextToken

public final String nextToken()

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Returns:

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

toBuilder

public AdminListGroupsForUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminListGroupsForUserRequest.Builder,AdminListGroupsForUserRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminListGroupsForUserRequest.Builder builder()

serializableBuilderClass

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