User.Builder (AWS Java SDK :: Services :: Finspace Data 2.20.162 API)

All Superinterfaces:

Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo

Enclosing class:

User
```
public static interface User.Builder
extends SdkPojo, CopyableBuilder<User.Builder,User>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`User.Builder`	`apiAccess(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.
`User.Builder`	`apiAccess(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.
`User.Builder`	`apiAccessPrincipalArn(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.
`User.Builder`	`createTime(Long createTime)` The timestamp at which the user was created in FinSpace.
`User.Builder`	`emailAddress(String emailAddress)` The email address of the user.
`User.Builder`	`firstName(String firstName)` The first name of the user.
`User.Builder`	`lastDisabledTime(Long lastDisabledTime)` Describes the last time the user was deactivated.
`User.Builder`	`lastEnabledTime(Long lastEnabledTime)` Describes the last time the user was activated.
`User.Builder`	`lastLoginTime(Long lastLoginTime)` Describes the last time that the user logged into their account.
`User.Builder`	`lastModifiedTime(Long lastModifiedTime)` Describes the last time the user was updated.
`User.Builder`	`lastName(String lastName)` The last name of the user.
`User.Builder`	`status(String status)` The current status of the user.
`User.Builder`	`status(UserStatus status)` The current status of the user.
`User.Builder`	`type(String type)` Indicates the type of user.
`User.Builder`	`type(UserType type)` Indicates the type of user.
`User.Builder`	`userId(String userId)` The unique identifier for the user.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - userId
```
User.Builder userId(String userId)
```
    The unique identifier for the user.
    
    Parameters:
    
    userId - The unique identifier for the user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - status
```
User.Builder status(String status)
```
    The current status of the user.
    - CREATING – The user 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 user 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, UserStatus
  - status
```
User.Builder status(UserStatus status)
```
    The current status of the user.
    - CREATING – The user 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 user 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, UserStatus
  - firstName
```
User.Builder firstName(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.
  - lastName
```
User.Builder lastName(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.
  - emailAddress
```
User.Builder emailAddress(String emailAddress)
```
    The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
    
    Parameters:
    
    emailAddress - The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - type
```
User.Builder type(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, UserType
  - type
```
User.Builder type(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, UserType
  - apiAccess
```
User.Builder apiAccess(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, ApiAccess
  - apiAccess
```
User.Builder apiAccess(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, ApiAccess
  - apiAccessPrincipalArn
```
User.Builder apiAccessPrincipalArn(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.
  - createTime
```
User.Builder createTime(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.
  - lastEnabledTime
```
User.Builder lastEnabledTime(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.
  - lastDisabledTime
```
User.Builder lastDisabledTime(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.
  - lastModifiedTime
```
User.Builder lastModifiedTime(Long lastModifiedTime)
```
    Describes the last time the user was updated. The value is determined as epoch time in milliseconds.
    
    Parameters:
    
    lastModifiedTime - Describes the last time the user was 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.
  - lastLoginTime
```
User.Builder lastLoginTime(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.

Interface User.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

userId

status

status

firstName

lastName

emailAddress

type

type

apiAccess

apiAccess

apiAccessPrincipalArn

createTime

lastEnabledTime

lastDisabledTime

lastModifiedTime

lastLoginTime