Package software.amazon.awssdk.services.finspacedata.model

Class User

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

The details of the user.

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

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

    • apiAccessAsString

      public final String apiAccessAsString()

      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.

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

    • apiAccessPrincipalArn

      public final 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.

      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.

    • createTime

      public final Long createTime()

      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.

    • lastEnabledTime

      public final Long lastEnabledTime()

      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.

    • lastDisabledTime

      public final Long lastDisabledTime()

      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.

    • lastModifiedTime

      public final Long lastModifiedTime()

      Describes the last time the user was updated. The value is determined as epoch time in milliseconds.

      Returns:
      Describes the last time the user was updated. The value is determined as epoch time in milliseconds.

    • lastLoginTime

      public final Long lastLoginTime()

      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.

    • toBuilder

      public User.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<User.Builder,User>
      Returns:
      a builder for type T

    • builder

      public static User.Builder builder()

    • serializableBuilderClass

      public static Class<? extends User.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.