UserPoolClientType (AWS Java SDK for Amazon Cognito Identity Provider Service 1.11.46 API)

java.lang.Object
- com.amazonaws.services.cognitoidp.model.UserPoolClientType

All Implemented Interfaces:

Serializable, Cloneable
```
public class UserPoolClientType
extends Object
implements Serializable, Cloneable
```
A user pool of the client type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserPoolClientType()

Constructors
Constructor and Description
`UserPoolClientType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserPoolClientType`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getClientId()` The ID of the client associated with the user pool.
`String`	`getClientName()` The client name from the user pool request of the client type.
`String`	`getClientSecret()` The client secret from the user pool request of the client type.
`Date`	`getCreationDate()` The creation date from the user pool request of the client type.
`List<String>`	`getExplicitAuthFlows()` The explicit authentication flows.
`Date`	`getLastModifiedDate()` The last modified date from the user pool request of the client type.
`List<String>`	`getReadAttributes()` The Read-only attributes.
`Integer`	`getRefreshTokenValidity()` The validity of the refresh token.
`String`	`getUserPoolId()` The user pool ID for the user pool client.
`List<String>`	`getWriteAttributes()` The writeable attributes.
`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 user pool request of the client type.
`void`	`setClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`void`	`setCreationDate(Date creationDate)` The creation date from the user pool request of the client type.
`void`	`setExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The last modified date from the user pool request of the client type.
`void`	`setReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`void`	`setRefreshTokenValidity(Integer refreshTokenValidity)` The validity of the refresh token.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`void`	`setWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UserPoolClientType`	`withClientId(String clientId)` The ID of the client associated with the user pool.
`UserPoolClientType`	`withClientName(String clientName)` The client name from the user pool request of the client type.
`UserPoolClientType`	`withClientSecret(String clientSecret)` The client secret from the user pool request of the client type.
`UserPoolClientType`	`withCreationDate(Date creationDate)` The creation date from the user pool request of the client type.
`UserPoolClientType`	`withExplicitAuthFlows(Collection<String> explicitAuthFlows)` The explicit authentication flows.
`UserPoolClientType`	`withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)` The explicit authentication flows.
`UserPoolClientType`	`withExplicitAuthFlows(String... explicitAuthFlows)` The explicit authentication flows.
`UserPoolClientType`	`withLastModifiedDate(Date lastModifiedDate)` The last modified date from the user pool request of the client type.
`UserPoolClientType`	`withReadAttributes(Collection<String> readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withReadAttributes(String... readAttributes)` The Read-only attributes.
`UserPoolClientType`	`withRefreshTokenValidity(Integer refreshTokenValidity)` The validity of the refresh token.
`UserPoolClientType`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool client.
`UserPoolClientType`	`withWriteAttributes(Collection<String> writeAttributes)` The writeable attributes.
`UserPoolClientType`	`withWriteAttributes(String... writeAttributes)` The writeable attributes.

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

- Constructor Detail
  - UserPoolClientType
```
public UserPoolClientType()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool client.
    
    Returns:
    
    The user pool ID for the user pool client.
  - withUserPoolId
```
public UserPoolClientType withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool client.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool client.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientName
```
public void setClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
  - getClientName
```
public String getClientName()
```
    The client name from the user pool request of the client type.
    
    Returns:
    
    The client name from the user pool request of the client type.
  - withClientName
```
public UserPoolClientType withClientName(String clientName)
```
    The client name from the user pool request of the client type.
    
    Parameters:
    
    clientName - The client name from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientId
```
public void setClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
  - getClientId
```
public String getClientId()
```
    The ID of the client associated with the user pool.
    
    Returns:
    
    The ID of the client associated with the user pool.
  - withClientId
```
public UserPoolClientType withClientId(String clientId)
```
    The ID of the client associated with the user pool.
    
    Parameters:
    
    clientId - The ID of the client associated with the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setClientSecret
```
public void setClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
  - getClientSecret
```
public String getClientSecret()
```
    The client secret from the user pool request of the client type.
    
    Returns:
    
    The client secret from the user pool request of the client type.
  - withClientSecret
```
public UserPoolClientType withClientSecret(String clientSecret)
```
    The client secret from the user pool request of the client type.
    
    Parameters:
    
    clientSecret - The client secret from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The last modified date from the user pool request of the client type.
    
    Parameters:
    
    lastModifiedDate - The last modified date from the user pool request of the client type.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The last modified date from the user pool request of the client type.
    
    Returns:
    
    The last modified date from the user pool request of the client type.
  - withLastModifiedDate
```
public UserPoolClientType withLastModifiedDate(Date lastModifiedDate)
```
    The last modified date from the user pool request of the client type.
    
    Parameters:
    
    lastModifiedDate - The last modified date from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The creation date from the user pool request of the client type.
    
    Parameters:
    
    creationDate - The creation date from the user pool request of the client type.
  - getCreationDate
```
public Date getCreationDate()
```
    The creation date from the user pool request of the client type.
    
    Returns:
    
    The creation date from the user pool request of the client type.
  - withCreationDate
```
public UserPoolClientType withCreationDate(Date creationDate)
```
    The creation date from the user pool request of the client type.
    
    Parameters:
    
    creationDate - The creation date from the user pool request of the client type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRefreshTokenValidity
```
public void setRefreshTokenValidity(Integer refreshTokenValidity)
```
    The validity of the refresh token.
    
    Parameters:
    
    refreshTokenValidity - The validity of the refresh token.
  - getRefreshTokenValidity
```
public Integer getRefreshTokenValidity()
```
    The validity of the refresh token.
    
    Returns:
    
    The validity of the refresh token.
  - withRefreshTokenValidity
```
public UserPoolClientType withRefreshTokenValidity(Integer refreshTokenValidity)
```
    The validity of the refresh token.
    
    Parameters:
    
    refreshTokenValidity - The validity of the refresh token.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReadAttributes
```
public List<String> getReadAttributes()
```
    The Read-only attributes.
    
    Returns:
    
    The Read-only attributes.
  - setReadAttributes
```
public void setReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(String... readAttributes)
```
    The Read-only attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setReadAttributes(java.util.Collection) or withReadAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReadAttributes
```
public UserPoolClientType withReadAttributes(Collection<String> readAttributes)
```
    The Read-only attributes.
    
    Parameters:
    
    readAttributes - The Read-only attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWriteAttributes
```
public List<String> getWriteAttributes()
```
    The writeable attributes.
    
    Returns:
    
    The writeable attributes.
  - setWriteAttributes
```
public void setWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(String... writeAttributes)
```
    The writeable attributes.
    
    NOTE: This method appends the values to the existing list (if any). Use setWriteAttributes(java.util.Collection) or withWriteAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWriteAttributes
```
public UserPoolClientType withWriteAttributes(Collection<String> writeAttributes)
```
    The writeable attributes.
    
    Parameters:
    
    writeAttributes - The writeable attributes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExplicitAuthFlows
```
public List<String> getExplicitAuthFlows()
```
    The explicit authentication flows.
    
    Returns:
    
    The explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - setExplicitAuthFlows
```
public void setExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(String... explicitAuthFlows)
```
    The explicit authentication flows.
    
    NOTE: This method appends the values to the existing list (if any). Use setExplicitAuthFlows(java.util.Collection) or withExplicitAuthFlows(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(Collection<String> explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - withExplicitAuthFlows
```
public UserPoolClientType withExplicitAuthFlows(ExplicitAuthFlowsType... explicitAuthFlows)
```
    The explicit authentication flows.
    
    Parameters:
    
    explicitAuthFlows - The explicit authentication flows.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExplicitAuthFlowsType
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UserPoolClientType clone()
```
    Overrides:
    
    clone in class Object

Class UserPoolClientType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserPoolClientType

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setClientName

getClientName

withClientName

setClientId

getClientId

withClientId

setClientSecret

getClientSecret

withClientSecret

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setCreationDate

getCreationDate

withCreationDate

setRefreshTokenValidity

getRefreshTokenValidity

withRefreshTokenValidity

getReadAttributes

setReadAttributes

withReadAttributes

withReadAttributes

getWriteAttributes

setWriteAttributes

withWriteAttributes

withWriteAttributes

getExplicitAuthFlows

setExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

withExplicitAuthFlows

toString

equals

hashCode

clone