UpdateUserPoolClientRequest (AWS SDK for Android - Amazon Cognito Identity Provider 2.6.15 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class UpdateUserPoolClientRequest
extends AmazonWebServiceRequest
implements Serializable
```
Allows the developer to update the specified user pool client and password policy.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateUserPoolClientRequest()

Constructors
Constructor and Description
`UpdateUserPoolClientRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getClientName()` The client name from the update user pool client request.
`List<String>`	`getExplicitAuthFlows()` Explicit authentication flows.
`List<String>`	`getReadAttributes()` The read-only attributes of the user pool.
`Integer`	`getRefreshTokenValidity()` The validity of the refresh token.
`String`	`getUserPoolId()` The user pool ID for the user pool where you want to update the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes of the user pool.
`int`	`hashCode()`
`void`	`setClientId(String clientId)` The ID of the client associated with the user pool.
`void`	`setClientName(String clientName)` The client name from the update user pool client request.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` Explicit authentication flows.
`void`	`setReadAttributes(Collection<String> readAttributes)` The read-only attributes of the user pool.
`void`	`setRefreshTokenValidity(Integer refreshTokenValidity)` The validity of the refresh token.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool where you want to update the user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The writeable attributes of the user pool.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateUserPoolClientRequest`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`UpdateUserPoolClientRequest`	`withClientName(String clientName)` The client name from the update user pool client request.
`UpdateUserPoolClientRequest`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` Explicit authentication flows.
`UpdateUserPoolClientRequest`	`withExplicitAuthFlows(String... explicitAuthFlows)` Explicit authentication flows.
`UpdateUserPoolClientRequest`	`withReadAttributes(Collection<String> readAttributes)` The read-only attributes of the user pool.
`UpdateUserPoolClientRequest`	`withReadAttributes(String... readAttributes)` The read-only attributes of the user pool.
`UpdateUserPoolClientRequest`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The validity of the refresh token.
`UpdateUserPoolClientRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool where you want to update the user pool client.
`UpdateUserPoolClientRequest`	`withWriteAttributes(Collection<String> writeAttributes)` The writeable attributes of the user pool.
`UpdateUserPoolClientRequest`	`withWriteAttributes(String... writeAttributes)` The writeable attributes of 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
  - UpdateUserPoolClientRequest
```
public UpdateUserPoolClientRequest()
```
- Method Detail
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID for the user pool where you want to update the user pool client.
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID for the user pool where you want to update the user pool client.
  - withUserPoolId
```
public UpdateUserPoolClientRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool where you want to update the user pool client.
    
    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 where you want to update the user pool client.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Returns:
    
    The ID of the client associated with the user pool.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
  - withClientId
```
public UpdateUserPoolClientRequest withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w+]+
    
    Parameters:
    
    clientId -
    The ID of the client associated with the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getClientName
```
public String getClientName()
```
    The client name from the update user pool client request.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Returns:
    
    The client name from the update user pool client request.
  - setClientName
```
public void setClientName(String clientName)
```
    The client name from the update user pool client request.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    clientName -
    The client name from the update user pool client request.
  - withClientName
```
public UpdateUserPoolClientRequest withClientName(String clientName)
```
    The client name from the update user pool client request.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w\s+=,.@-]+
    
    Parameters:
    
    clientName -
    The client name from the update user pool client request.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRefreshTokenValidity
```
public Integer getRefreshTokenValidity()
```
    The validity of the refresh token.
    
    Constraints:
    Range: 0 - 3650
    
    Returns:
    
    The validity of the refresh token.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(Integer refreshTokenValidity)
```
    The validity of the refresh token.
    
    Constraints:
    Range: 0 - 3650
    
    Parameters:
    
    refreshTokenValidity -
    The validity of the refresh token.
  - withRefreshTokenValidity
```
public UpdateUserPoolClientRequest withRefreshTokenValidity(Integer refreshTokenValidity)
```
    The validity of the refresh token.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 - 3650
    
    Parameters:
    
    refreshTokenValidity -
    The validity of the refresh token.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getReadAttributes
```
public List<String> getReadAttributes()
```
    The read-only attributes of the user pool.
    
    Returns:
    
    The read-only attributes of the user pool.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The read-only attributes of the user pool.
    
    Parameters:
    
    readAttributes -
    The read-only attributes of the user pool.
  - withReadAttributes
```
public UpdateUserPoolClientRequest withReadAttributes(String... readAttributes)
```
    The read-only attributes of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    readAttributes -
    The read-only attributes of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withReadAttributes
```
public UpdateUserPoolClientRequest withReadAttributes(Collection<String> readAttributes)
```
    The read-only attributes of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    readAttributes -
    The read-only attributes of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The writeable attributes of the user pool.
    
    Returns:
    
    The writeable attributes of the user pool.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes of the user pool.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes of the user pool.
  - withWriteAttributes
```
public UpdateUserPoolClientRequest withWriteAttributes(String... writeAttributes)
```
    The writeable attributes of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withWriteAttributes
```
public UpdateUserPoolClientRequest withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes of the user pool.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    writeAttributes -
    The writeable attributes of the user pool.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<String> getExplicitAuthFlows()
```
    Explicit authentication flows.
    
    Returns:
    
    Explicit authentication flows.
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    Explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows -
    Explicit authentication flows.
  - withExplicitAuthFlows
```
public UpdateUserPoolClientRequest withExplicitAuthFlows(String... explicitAuthFlows)
```
    Explicit authentication flows.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    explicitAuthFlows -
    Explicit authentication flows.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withExplicitAuthFlows
```
public UpdateUserPoolClientRequest withExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    Explicit authentication flows.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    explicitAuthFlows -
    Explicit authentication flows.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class UpdateUserPoolClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUserPoolClientRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getClientId

setClientId

withClientId

getClientName

setClientName

withClientName

getRefreshTokenValidity

setRefreshTokenValidity

withRefreshTokenValidity

getReadAttributes

setReadAttributes

withReadAttributes

withReadAttributes

getWriteAttributes

setWriteAttributes

withWriteAttributes

withWriteAttributes

getExplicitAuthFlows

setExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

toString

hashCode

equals