UserByPermissionGroup (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.finspacedata.model.UserByPermissionGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UserByPermissionGroup
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The structure of a user account associated with a permission group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

UserByPermissionGroup()

Constructors
Constructor and Description
`UserByPermissionGroup()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserByPermissionGroup`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApiAccess()` Indicates whether the user can access FinSpace API operations.
`String`	`getApiAccessPrincipalArn()` The IAM ARN identifier that is attached to FinSpace API calls.
`String`	`getEmailAddress()` The email address of the user.
`String`	`getFirstName()` The first name of the user.
`String`	`getLastName()` The last name of the user.
`String`	`getMembershipStatus()` Indicates the status of the user account within a permission group.
`String`	`getStatus()` The current status of the user account.
`String`	`getType()` Indicates the type of user.
`String`	`getUserId()` The unique identifier for the user.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiAccess(String apiAccess)` Indicates whether the user can access FinSpace API operations.
`void`	`setApiAccessPrincipalArn(String apiAccessPrincipalArn)` The IAM ARN identifier that is attached to FinSpace API calls.
`void`	`setEmailAddress(String emailAddress)` The email address of the user.
`void`	`setFirstName(String firstName)` The first name of the user.
`void`	`setLastName(String lastName)` The last name of the user.
`void`	`setMembershipStatus(String membershipStatus)` Indicates the status of the user account within a permission group.
`void`	`setStatus(String status)` The current status of the user account.
`void`	`setType(String type)` Indicates the type of user.
`void`	`setUserId(String userId)` The unique identifier for the user.
`String`	`toString()` Returns a string representation of this object.
`UserByPermissionGroup`	`withApiAccess(ApiAccess apiAccess)` Indicates whether the user can access FinSpace API operations.
`UserByPermissionGroup`	`withApiAccess(String apiAccess)` Indicates whether the user can access FinSpace API operations.
`UserByPermissionGroup`	`withApiAccessPrincipalArn(String apiAccessPrincipalArn)` The IAM ARN identifier that is attached to FinSpace API calls.
`UserByPermissionGroup`	`withEmailAddress(String emailAddress)` The email address of the user.
`UserByPermissionGroup`	`withFirstName(String firstName)` The first name of the user.
`UserByPermissionGroup`	`withLastName(String lastName)` The last name of the user.
`UserByPermissionGroup`	`withMembershipStatus(PermissionGroupMembershipStatus membershipStatus)` Indicates the status of the user account within a permission group.
`UserByPermissionGroup`	`withMembershipStatus(String membershipStatus)` Indicates the status of the user account within a permission group.
`UserByPermissionGroup`	`withStatus(String status)` The current status of the user account.
`UserByPermissionGroup`	`withStatus(UserStatus status)` The current status of the user account.
`UserByPermissionGroup`	`withType(String type)` Indicates the type of user.
`UserByPermissionGroup`	`withType(UserType type)` Indicates the type of user.
`UserByPermissionGroup`	`withUserId(String userId)` The unique identifier for the user.

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

- Constructor Detail
  - UserByPermissionGroup
```
public UserByPermissionGroup()
```
- Method Detail
  - setUserId
```
public void setUserId(String userId)
```
    The unique identifier for the user.
    
    Parameters:
    
    userId - The unique identifier for the user.
  - getUserId
```
public String getUserId()
```
    The unique identifier for the user.
    
    Returns:
    
    The unique identifier for the user.
  - withUserId
```
public UserByPermissionGroup withUserId(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.
  - setStatus
```
public void setStatus(String status)
```
    The current status of the user account.
    - CREATING – The user account creation is in progress.
    - ENABLED – The user account is created and is currently active.
    - DISABLED – The user account is currently inactive.
    Parameters:
    status - The current status of the user account.
    
    CREATING – The user account creation is in progress.
    
    ENABLED – The user account is created and is currently active.
    
    DISABLED – The user account is currently inactive.
    See Also:
    
    UserStatus
  - getStatus
```
public String getStatus()
```
    The current status of the user account.
    - CREATING – The user account creation is in progress.
    - ENABLED – The user account is created and is currently active.
    - DISABLED – The user account is currently inactive.
    Returns:
    The current status of the user account.
    
    CREATING – The user account creation is in progress.
    
    ENABLED – The user account is created and is currently active.
    
    DISABLED – The user account is currently inactive.
    See Also:
    
    UserStatus
  - withStatus
```
public UserByPermissionGroup withStatus(String status)
```
    The current status of the user account.
    - CREATING – The user account creation is in progress.
    - ENABLED – The user account is created and is currently active.
    - DISABLED – The user account is currently inactive.
    Parameters:
    status - The current status of the user account.
    
    CREATING – The user account creation is in progress.
    
    ENABLED – The user account is created and is currently active.
    
    DISABLED – The user account is currently inactive.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserStatus
  - withStatus
```
public UserByPermissionGroup withStatus(UserStatus status)
```
    The current status of the user account.
    - CREATING – The user account creation is in progress.
    - ENABLED – The user account is created and is currently active.
    - DISABLED – The user account is currently inactive.
    Parameters:
    status - The current status of the user account.
    
    CREATING – The user account creation is in progress.
    
    ENABLED – The user account is created and is currently active.
    
    DISABLED – The user account 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 UserByPermissionGroup 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 UserByPermissionGroup 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 of the user. The email address serves as a unique 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 unique identifier for each user and cannot be changed after it's created.
  - getEmailAddress
```
public String getEmailAddress()
```
    The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
    
    Returns:
    
    The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
  - withEmailAddress
```
public UserByPermissionGroup withEmailAddress(String emailAddress)
```
    The email address of the user. The email address serves as a unique 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 unique 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.
  - 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 UserByPermissionGroup 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 UserByPermissionGroup 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 access FinSpace API operations.
    - ENABLED – The user has permissions to use the API operations.
    - DISABLED – The user does not have permissions to use any API operations.
    Parameters:
    apiAccess - Indicates whether the user can access FinSpace API operations.
    
    ENABLED – The user has permissions to use the API operations.
    
    DISABLED – The user does not have permissions to use any API operations.
    See Also:
    
    ApiAccess
  - getApiAccess
```
public String getApiAccess()
```
    Indicates whether the user can access FinSpace API operations.
    - ENABLED – The user has permissions to use the API operations.
    - DISABLED – The user does not have permissions to use any API operations.
    Returns:
    Indicates whether the user can access FinSpace API operations.
    
    ENABLED – The user has permissions to use the API operations.
    
    DISABLED – The user does not have permissions to use any API operations.
    See Also:
    
    ApiAccess
  - withApiAccess
```
public UserByPermissionGroup withApiAccess(String apiAccess)
```
    Indicates whether the user can access FinSpace API operations.
    - ENABLED – The user has permissions to use the API operations.
    - DISABLED – The user does not have permissions to use any API operations.
    Parameters:
    apiAccess - Indicates whether the user can access FinSpace API operations.
    
    ENABLED – The user has permissions to use the API operations.
    
    DISABLED – The user does not have permissions to use any API operations.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ApiAccess
  - withApiAccess
```
public UserByPermissionGroup withApiAccess(ApiAccess apiAccess)
```
    Indicates whether the user can access FinSpace API operations.
    - ENABLED – The user has permissions to use the API operations.
    - DISABLED – The user does not have permissions to use any API operations.
    Parameters:
    apiAccess - Indicates whether the user can access FinSpace API operations.
    
    ENABLED – The user has permissions to use the API operations.
    
    DISABLED – The user does not have permissions to use any API operations.
    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 IAM ARN identifier that is attached to FinSpace API calls.
    
    Parameters:
    
    apiAccessPrincipalArn - The IAM ARN identifier that is attached to FinSpace API calls.
  - getApiAccessPrincipalArn
```
public String getApiAccessPrincipalArn()
```
    The IAM ARN identifier that is attached to FinSpace API calls.
    
    Returns:
    
    The IAM ARN identifier that is attached to FinSpace API calls.
  - withApiAccessPrincipalArn
```
public UserByPermissionGroup withApiAccessPrincipalArn(String apiAccessPrincipalArn)
```
    The IAM ARN identifier that is attached to FinSpace API calls.
    
    Parameters:
    
    apiAccessPrincipalArn - The IAM ARN identifier that is attached to FinSpace API calls.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMembershipStatus
```
public void setMembershipStatus(String membershipStatus)
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Parameters:
    membershipStatus - Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    See Also:
    
    PermissionGroupMembershipStatus
  - getMembershipStatus
```
public String getMembershipStatus()
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Returns:
    Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    See Also:
    
    PermissionGroupMembershipStatus
  - withMembershipStatus
```
public UserByPermissionGroup withMembershipStatus(String membershipStatus)
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Parameters:
    membershipStatus - Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PermissionGroupMembershipStatus
  - withMembershipStatus
```
public UserByPermissionGroup withMembershipStatus(PermissionGroupMembershipStatus membershipStatus)
```
    Indicates the status of the user account within a permission group.
    - ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    - ADDITION_SUCCESS – The user account is successfully added to the permission group.
    - REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Parameters:
    membershipStatus - Indicates the status of the user account within a permission group.
    
    ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
    
    ADDITION_SUCCESS – The user account is successfully added to the permission group.
    
    REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PermissionGroupMembershipStatus
  - 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 UserByPermissionGroup clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class UserByPermissionGroup

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserByPermissionGroup

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

setMembershipStatus

getMembershipStatus

withMembershipStatus

withMembershipStatus

toString

equals

hashCode

clone

marshall