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

Class CreateUserRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.finspacedata.model.FinspaceDataRequest
software.amazon.awssdk.services.finspacedata.model.CreateUserRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateUserRequest extends FinspaceDataRequest implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

  • Method Details

    • emailAddress

      public final String emailAddress()

      The email address of the user that you want to register. 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 that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

    • type

      public final UserType type()

      The option to indicate the type of user. Use one of the following options to specify this parameter:

      • 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:
      The option to indicate the type of user. Use one of the following options to specify this parameter:

      • 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()

      The option to indicate the type of user. Use one of the following options to specify this parameter:

      • 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:
      The option to indicate the type of user. Use one of the following options to specify this parameter:

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

    • firstName

      public final String firstName()

      The first name of the user that you want to register.

      Returns:
      The first name of the user that you want to register.

    • lastName

      public final String lastName()

      The last name of the user that you want to register.

      Returns:
      The last name of the user that you want to register.

    • apiAccess

      public final ApiAccess apiAccess()

      The option to indicate 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:
      The option to indicate 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()

      The option to indicate 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:
      The option to indicate 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.

    • clientToken

      public final String clientToken()

      A token that ensures idempotency. This token expires in 10 minutes.

      Returns:
      A token that ensures idempotency. This token expires in 10 minutes.

    • toBuilder

      public CreateUserRequest.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<CreateUserRequest.Builder,CreateUserRequest>
      Specified by:
      toBuilder in class FinspaceDataRequest
      Returns:
      a builder for type T

    • builder

      public static CreateUserRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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