AdminListGroupsForUserRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.AdminListGroupsForUserRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AdminListGroupsForUserRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Lists the groups that the user belongs to.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminListGroupsForUserRequest()

Constructors
Constructor and Description
`AdminListGroupsForUserRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getLimit()` The limit of the request to list groups.
`java.lang.String`	`getNextToken()` 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.
`java.lang.String`	`getUsername()` The username for the user.
`java.lang.String`	`getUserPoolId()` The user pool ID for the user pool.
`int`	`hashCode()`
`void`	`setLimit(java.lang.Integer limit)` The limit of the request to list groups.
`void`	`setNextToken(java.lang.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.
`void`	`setUsername(java.lang.String username)` The username for the user.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminListGroupsForUserRequest`	`withLimit(java.lang.Integer limit)` The limit of the request to list groups.
`AdminListGroupsForUserRequest`	`withNextToken(java.lang.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.
`AdminListGroupsForUserRequest`	`withUsername(java.lang.String username)` The username for the user.
`AdminListGroupsForUserRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID for the user pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdminListGroupsForUserRequest
```
public AdminListGroupsForUserRequest()
```
- Method Detail
  - getUsername
```
public java.lang.String getUsername()
```
    The username for the user.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The username for the user.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The username for the user.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The username for the user.
  - withUsername
```
public AdminListGroupsForUserRequest withUsername(java.lang.String username)
```
    The username for the user.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The username for the user.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID for the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool.
  - withUserPoolId
```
public AdminListGroupsForUserRequest withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID for the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public java.lang.Integer getLimit()
```
    The limit of the request to list groups.
    
    Constraints:
    Range: 0 - 60
    
    Returns:
    
    The limit of the request to list groups.
  - setLimit
```
public void setLimit(java.lang.Integer limit)
```
    The limit of the request to list groups.
    
    Constraints:
    Range: 0 - 60
    
    Parameters:
    
    limit -
    The limit of the request to list groups.
  - withLimit
```
public AdminListGroupsForUserRequest withLimit(java.lang.Integer limit)
```
    The limit of the request to list groups.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 - 60
    
    Parameters:
    
    limit -
    The limit of the request to list groups.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getNextToken
```
public java.lang.String getNextToken()
```
    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.
    
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    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.
  - setNextToken
```
public void setNextToken(java.lang.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.
    
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    Parameters:
    
    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.
  - withNextToken
```
public AdminListGroupsForUserRequest withNextToken(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    Pattern: [\S]+
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AdminListGroupsForUserRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminListGroupsForUserRequest

Method Detail

getUsername

setUsername

withUsername

getUserPoolId

setUserPoolId

withUserPoolId

getLimit

setLimit

withLimit

getNextToken

setNextToken

withNextToken

toString

hashCode

equals