CreateUserRequest (AWS Java SDK :: Services :: Finspace Data 2.18.35 API)

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(value="software.amazon.awssdk:codegen")
public final class CreateUserRequest
extends FinspaceDataRequest
implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateUserRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`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.
`static CreateUserRequest.Builder`	`builder()`
`String`	`clientToken()` A token that ensures idempotency.
`String`	`emailAddress()` The email address of the user that you want to register.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`firstName()` The first name of the user that you want to register.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`lastName()` The last name of the user that you want to register.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateUserRequest.Builder>`	`serializableBuilderClass()`
`CreateUserRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`UserType`	`type()` The option to indicate the type of user.
`String`	`typeAsString()` The option to indicate the type of user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - 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:
    
    UserType
  - 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:
    
    UserType
  - 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:
    
    ApiAccess
  - 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:
    
    ApiAccess
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
    
    Specified by:
    
    toBuilder in class FinspaceDataRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateUserRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

emailAddress

type

typeAsString

firstName

lastName

apiAccess

apiAccessAsString

apiAccessPrincipalArn

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields