GetUserResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.finspacedata.model.GetUserResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUserResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetUserResult()

Constructors
Constructor and Description
`GetUserResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetUserResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiAccess()` Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.
`String`	`getApiAccessPrincipalArn()` The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user.
`Long`	`getCreateTime()` The timestamp at which the user was created in FinSpace.
`String`	`getEmailAddress()` The email address that is associated with the user.
`String`	`getFirstName()` The first name of the user.
`Long`	`getLastDisabledTime()` Describes the last time the user was deactivated.
`Long`	`getLastEnabledTime()` Describes the last time the user was activated.
`Long`	`getLastLoginTime()` Describes the last time that the user logged into their account.
`Long`	`getLastModifiedTime()` Describes the last time the user details were updated.
`String`	`getLastName()` The last name of the user.
`String`	`getStatus()` The current status of the user.
`String`	`getType()` Indicates the type of user.
`String`	`getUserId()` The unique identifier for the user that is retrieved.
`int`	`hashCode()`
`void`	`setApiAccess(String apiAccess)` Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.
`void`	`setApiAccessPrincipalArn(String apiAccessPrincipalArn)` The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user.
`void`	`setCreateTime(Long createTime)` The timestamp at which the user was created in FinSpace.
`void`	`setEmailAddress(String emailAddress)` The email address that is associated with the user.
`void`	`setFirstName(String firstName)` The first name of the user.
`void`	`setLastDisabledTime(Long lastDisabledTime)` Describes the last time the user was deactivated.
`void`	`setLastEnabledTime(Long lastEnabledTime)` Describes the last time the user was activated.
`void`	`setLastLoginTime(Long lastLoginTime)` Describes the last time that the user logged into their account.
`void`	`setLastModifiedTime(Long lastModifiedTime)` Describes the last time the user details were updated.
`void`	`setLastName(String lastName)` The last name of the user.
`void`	`setStatus(String status)` The current status of the user.
`void`	`setType(String type)` Indicates the type of user.
`void`	`setUserId(String userId)` The unique identifier for the user that is retrieved.
`String`	`toString()` Returns a string representation of this object.
`GetUserResult`	`withApiAccess(ApiAccess apiAccess)` Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.
`GetUserResult`	`withApiAccess(String apiAccess)` Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.
`GetUserResult`	`withApiAccessPrincipalArn(String apiAccessPrincipalArn)` The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user.
`GetUserResult`	`withCreateTime(Long createTime)` The timestamp at which the user was created in FinSpace.
`GetUserResult`	`withEmailAddress(String emailAddress)` The email address that is associated with the user.
`GetUserResult`	`withFirstName(String firstName)` The first name of the user.
`GetUserResult`	`withLastDisabledTime(Long lastDisabledTime)` Describes the last time the user was deactivated.
`GetUserResult`	`withLastEnabledTime(Long lastEnabledTime)` Describes the last time the user was activated.
`GetUserResult`	`withLastLoginTime(Long lastLoginTime)` Describes the last time that the user logged into their account.
`GetUserResult`	`withLastModifiedTime(Long lastModifiedTime)` Describes the last time the user details were updated.
`GetUserResult`	`withLastName(String lastName)` The last name of the user.
`GetUserResult`	`withStatus(String status)` The current status of the user.
`GetUserResult`	`withStatus(UserStatus status)` The current status of the user.
`GetUserResult`	`withType(String type)` Indicates the type of user.
`GetUserResult`	`withType(UserType type)` Indicates the type of user.
`GetUserResult`	`withUserId(String userId)` The unique identifier for the user that is retrieved.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetUserResult
```
public GetUserResult()
```
- Method Detail
  - setUserId
```
public void setUserId(String userId)
```
    The unique identifier for the user that is retrieved.
    
    Parameters:
    
    userId - The unique identifier for the user that is retrieved.
  - getUserId
```
public String getUserId()
```
    The unique identifier for the user that is retrieved.
    
    Returns:
    
    The unique identifier for the user that is retrieved.
  - withUserId
```
public GetUserResult withUserId(String userId)
```
    The unique identifier for the user that is retrieved.
    
    Parameters:
    
    userId - The unique identifier for the user that is retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the user.
    - CREATING – The creation is in progress.
    - ENABLED – The user is created and is currently active.
    - DISABLED – The user is currently inactive.
    Parameters:
    status - The current status of the user.
    
    CREATING – The creation is in progress.
    
    ENABLED – The user is created and is currently active.
    
    DISABLED – The user is currently inactive.
    See Also:
    
    UserStatus
  - getStatus
```
public String getStatus()
```
    The current status of the user.
    - CREATING – The creation is in progress.
    - ENABLED – The user is created and is currently active.
    - DISABLED – The user is currently inactive.
    Returns:
    The current status of the user.
    
    CREATING – The creation is in progress.
    
    ENABLED – The user is created and is currently active.
    
    DISABLED – The user is currently inactive.
    See Also:
    
    UserStatus
  - withStatus
```
public GetUserResult withStatus(String status)
```
    The current status of the user.
    - CREATING – The creation is in progress.
    - ENABLED – The user is created and is currently active.
    - DISABLED – The user is currently inactive.
    Parameters:
    status - The current status of the user.
    
    CREATING – The creation is in progress.
    
    ENABLED – The user is created and is currently active.
    
    DISABLED – The user is currently inactive.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserStatus
  - withStatus
```
public GetUserResult withStatus(UserStatus status)
```
    The current status of the user.
    - CREATING – The creation is in progress.
    - ENABLED – The user is created and is currently active.
    - DISABLED – The user is currently inactive.
    Parameters:
    status - The current status of the user.
    
    CREATING – The creation is in progress.
    
    ENABLED – The user is created and is currently active.
    
    DISABLED – The user is currently inactive.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserStatus
  - setFirstName
```
public void setFirstName(String firstName)
```
    The first name of the user.
    
    Parameters:
    
    firstName - The first name of the user.
  - getFirstName
```
public String getFirstName()
```
    The first name of the user.
    
    Returns:
    
    The first name of the user.
  - withFirstName
```
public GetUserResult withFirstName(String firstName)
```
    The first name of the user.
    
    Parameters:
    
    firstName - The first name of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastName
```
public void setLastName(String lastName)
```
    The last name of the user.
    
    Parameters:
    
    lastName - The last name of the user.
  - getLastName
```
public String getLastName()
```
    The last name of the user.
    
    Returns:
    
    The last name of the user.
  - withLastName
```
public GetUserResult withLastName(String lastName)
```
    The last name of the user.
    
    Parameters:
    
    lastName - The last name of the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailAddress
```
public void setEmailAddress(String emailAddress)
```
    The email address that is associated with the user.
    
    Parameters:
    
    emailAddress - The email address that is associated with the user.
  - getEmailAddress
```
public String getEmailAddress()
```
    The email address that is associated with the user.
    
    Returns:
    
    The email address that is associated with the user.
  - withEmailAddress
```
public GetUserResult withEmailAddress(String emailAddress)
```
    The email address that is associated with the user.
    
    Parameters:
    
    emailAddress - The email address that is associated with the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Indicates the type of user.
    - SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    - APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Parameters:
    type - Indicates the type of user.
    
    SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    
    APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    See Also:
    
    UserType
  - getType
```
public String getType()
```
    Indicates the type of user.
    - SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    - APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Returns:
    Indicates the type of user.
    
    SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    
    APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    See Also:
    
    UserType
  - withType
```
public GetUserResult withType(String type)
```
    Indicates the type of user.
    - SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    - APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Parameters:
    type - Indicates the type of user.
    
    SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    
    APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserType
  - withType
```
public GetUserResult withType(UserType type)
```
    Indicates the type of user.
    - SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    - APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Parameters:
    type - Indicates the type of user.
    
    SUPER_USER – A user with permission to all the functionality and data in FinSpace.
    
    APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserType
  - setApiAccess
```
public void setApiAccess(String apiAccess)
```
    Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    - ENABLED – The user has permissions to use the APIs.
    - DISABLED – The user does not have permissions to use any APIs.
    Parameters:
    apiAccess - Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    
    ENABLED – The user has permissions to use the APIs.
    
    DISABLED – The user does not have permissions to use any APIs.
    See Also:
    
    ApiAccess
  - getApiAccess
```
public String getApiAccess()
```
    Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    - ENABLED – The user has permissions to use the APIs.
    - DISABLED – The user does not have permissions to use any APIs.
    Returns:
    Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    
    ENABLED – The user has permissions to use the APIs.
    
    DISABLED – The user does not have permissions to use any APIs.
    See Also:
    
    ApiAccess
  - withApiAccess
```
public GetUserResult withApiAccess(String apiAccess)
```
    Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    - ENABLED – The user has permissions to use the APIs.
    - DISABLED – The user does not have permissions to use any APIs.
    Parameters:
    apiAccess - Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    
    ENABLED – The user has permissions to use the APIs.
    
    DISABLED – The user does not have permissions to use any APIs.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiAccess
  - withApiAccess
```
public GetUserResult withApiAccess(ApiAccess apiAccess)
```
    Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    - ENABLED – The user has permissions to use the APIs.
    - DISABLED – The user does not have permissions to use any APIs.
    Parameters:
    apiAccess - Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
    
    ENABLED – The user has permissions to use the APIs.
    
    DISABLED – The user does not have permissions to use any APIs.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiAccess
  - setApiAccessPrincipalArn
```
public void setApiAccessPrincipalArn(String apiAccessPrincipalArn)
```
    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
    
    Parameters:
    
    apiAccessPrincipalArn - The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
  - getApiAccessPrincipalArn
```
public String getApiAccessPrincipalArn()
```
    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
    
    Returns:
    
    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
  - withApiAccessPrincipalArn
```
public GetUserResult withApiAccessPrincipalArn(String apiAccessPrincipalArn)
```
    The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
    
    Parameters:
    
    apiAccessPrincipalArn - The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreateTime
```
public void setCreateTime(Long createTime)
```
    The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    createTime - The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
  - getCreateTime
```
public Long getCreateTime()
```
    The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
  - withCreateTime
```
public GetUserResult withCreateTime(Long createTime)
```
    The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    createTime - The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastEnabledTime
```
public void setLastEnabledTime(Long lastEnabledTime)
```
    Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastEnabledTime - Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
  - getLastEnabledTime
```
public Long getLastEnabledTime()
```
    Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
  - withLastEnabledTime
```
public GetUserResult withLastEnabledTime(Long lastEnabledTime)
```
    Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastEnabledTime - Describes the last time the user was activated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastDisabledTime
```
public void setLastDisabledTime(Long lastDisabledTime)
```
    Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastDisabledTime - Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
  - getLastDisabledTime
```
public Long getLastDisabledTime()
```
    Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
  - withLastDisabledTime
```
public GetUserResult withLastDisabledTime(Long lastDisabledTime)
```
    Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastDisabledTime - Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Long lastModifiedTime)
```
    Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastModifiedTime - Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
  - getLastModifiedTime
```
public Long getLastModifiedTime()
```
    Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
  - withLastModifiedTime
```
public GetUserResult withLastModifiedTime(Long lastModifiedTime)
```
    Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastModifiedTime - Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastLoginTime
```
public void setLastLoginTime(Long lastLoginTime)
```
    Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastLoginTime - Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
  - getLastLoginTime
```
public Long getLastLoginTime()
```
    Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
  - withLastLoginTime
```
public GetUserResult withLastLoginTime(Long lastLoginTime)
```
    Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastLoginTime - Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    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 GetUserResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class GetUserResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetUserResult

Method Detail

setUserId

getUserId

withUserId

setStatus

getStatus

withStatus

withStatus

setFirstName

getFirstName

withFirstName

setLastName

getLastName

withLastName

setEmailAddress

getEmailAddress

withEmailAddress

setType

getType

withType

withType

setApiAccess

getApiAccess

withApiAccess

withApiAccess

setApiAccessPrincipalArn

getApiAccessPrincipalArn

withApiAccessPrincipalArn

setCreateTime

getCreateTime

withCreateTime

setLastEnabledTime

getLastEnabledTime

withLastEnabledTime

setLastDisabledTime

getLastDisabledTime

withLastDisabledTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setLastLoginTime

getLastLoginTime

withLastLoginTime

toString

equals

hashCode

clone