UserByPermissionGroup (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.finspacedata.model.UserByPermissionGroup

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>

@Generated(value="software.amazon.awssdk:codegen")
public final class UserByPermissionGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>

The structure of a user account associated with a permission group.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UserByPermissionGroup.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UserByPermissionGroup.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApiAccess`	`apiAccess()` Indicates whether the user can access FinSpace API operations.
`String`	`apiAccessAsString()` Indicates whether the user can access FinSpace API operations.
`String`	`apiAccessPrincipalArn()` The IAM ARN identifier that is attached to FinSpace API calls.
`static UserByPermissionGroup.Builder`	`builder()`
`String`	`emailAddress()` The email address of the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firstName()` The first name of the user.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`lastName()` The last name of the user.
`PermissionGroupMembershipStatus`	`membershipStatus()` Indicates the status of the user account within a permission group.
`String`	`membershipStatusAsString()` Indicates the status of the user account within a permission group.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UserByPermissionGroup.Builder>`	`serializableBuilderClass()`
`UserStatus`	`status()` The current status of the user account.
`String`	`statusAsString()` The current status of the user account.
`UserByPermissionGroup.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserType`	`type()` Indicates the type of user.
`String`	`typeAsString()` Indicates the type of user.
`String`	`userId()` The unique identifier for the user.

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

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

- Method Detail
  - userId
```
public final String userId()
```
    The unique identifier for the user.
    
    Returns:
    
    The unique identifier for the user.
  - status
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, status will return UserStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - statusAsString
```
public final String statusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, status will return UserStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    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
  - firstName
```
public final String firstName()
```
    The first name of the user.
    
    Returns:
    
    The first name of the user.
  - lastName
```
public final String lastName()
```
    The last name of the user.
    
    Returns:
    
    The last name of the user.
  - emailAddress
```
public final 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.
    
    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.
  - type
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, type will return UserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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
  - typeAsString
```
public final String typeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, type will return UserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    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
  - apiAccess
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, apiAccess will return ApiAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiAccessAsString().
    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
  - apiAccessAsString
```
public final String apiAccessAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, apiAccess will return ApiAccess.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from apiAccessAsString().
    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
  - apiAccessPrincipalArn
```
public final String apiAccessPrincipalArn()
```
    The IAM ARN identifier that is attached to FinSpace API calls.
    
    Returns:
    
    The IAM ARN identifier that is attached to FinSpace API calls.
  - membershipStatus
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, membershipStatus will return PermissionGroupMembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipStatusAsString().
    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
  - membershipStatusAsString
```
public final String membershipStatusAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, membershipStatus will return PermissionGroupMembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from membershipStatusAsString().
    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
  - toBuilder
```
public UserByPermissionGroup.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>
  - builder
```
public static UserByPermissionGroup.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UserByPermissionGroup.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UserByPermissionGroup

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

userId

status

statusAsString

firstName

lastName

emailAddress

type

typeAsString

apiAccess

apiAccessAsString

apiAccessPrincipalArn

membershipStatus

membershipStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields