Class UserByPermissionGroup

java.lang.Object
software.amazon.awssdk.services.finspacedata.model.UserByPermissionGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>
@Generated("software.amazon.awssdk:codegen") public final class UserByPermissionGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>

The structure of a user associated with a permission group.

See Also:

  • Method Details

    • 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.

      • CREATING – The user creation is in progress.

      • ENABLED – The user is created and is currently active.

      • DISABLED – The user 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.

      • CREATING – The user creation is in progress.

      • ENABLED – The user is created and is currently active.

      • DISABLED – The user is currently inactive.

      See Also:

    • statusAsString

      public final String statusAsString()

      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.

      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.

      • CREATING – The user creation is in progress.

      • ENABLED – The user is created and is currently active.

      • DISABLED – The user is currently inactive.

      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 within a permission group.

      • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

      • ADDITION_SUCCESS – The user 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 within a permission group.

      • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

      • ADDITION_SUCCESS – The user is successfully added to the permission group.

      • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

      See Also:

    • membershipStatusAsString

      public final String membershipStatusAsString()

      Indicates the status of the user within a permission group.

      • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

      • ADDITION_SUCCESS – The user 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 within a permission group.

      • ADDITION_IN_PROGRESS – The user is currently being added to the permission group.

      • ADDITION_SUCCESS – The user is successfully added to the permission group.

      • REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

      See Also:

    • toBuilder

      public UserByPermissionGroup.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.