com.amazonaws.services.finspacedata.model

Class CreateUserRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.finspacedata.model.CreateUserRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateUserRequest()

Method Summary

Modifier and Type	Method and Description
CreateUserRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiAccess() 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	getApiAccessPrincipalArn() 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.
String	getClientToken() A token that ensures idempotency.
String	getEmailAddress() The email address of the user that you want to register.
String	getFirstName() The first name of the user that you want to register.
String	getLastName() The last name of the user that you want to register.
String	getType() The option to indicate the type of user.
int	hashCode()
void	setApiAccess(String 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.
void	setApiAccessPrincipalArn(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.
void	setClientToken(String clientToken) A token that ensures idempotency.
void	setEmailAddress(String emailAddress) The email address of the user that you want to register.
void	setFirstName(String firstName) The first name of the user that you want to register.
void	setLastName(String lastName) The last name of the user that you want to register.
void	setType(String type) The option to indicate the type of user.
String	toString() Returns a string representation of this object.
CreateUserRequest	withApiAccess(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.
CreateUserRequest	withApiAccess(String 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.
CreateUserRequest	withApiAccessPrincipalArn(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.
CreateUserRequest	withClientToken(String clientToken) A token that ensures idempotency.
CreateUserRequest	withEmailAddress(String emailAddress) The email address of the user that you want to register.
CreateUserRequest	withFirstName(String firstName) The first name of the user that you want to register.
CreateUserRequest	withLastName(String lastName) The last name of the user that you want to register.
CreateUserRequest	withType(String type) The option to indicate the type of user.
CreateUserRequest	withType(UserType type) The option to indicate the type of user.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateUserRequest

public CreateUserRequest()

Method Detail

setEmailAddress

public void setEmailAddress(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.

Parameters:

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.

getEmailAddress

public String getEmailAddress()

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.

withEmailAddress

public CreateUserRequest withEmailAddress(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String 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.

Parameters:

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.

See Also:

UserType

getType

public String getType()

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.

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

withType

public CreateUserRequest withType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserType

withType

public CreateUserRequest withType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserType

setFirstName

public void setFirstName(String firstName)

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

Parameters:

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

getFirstName

public String getFirstName()

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

Returns:

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

withFirstName

public CreateUserRequest withFirstName(String firstName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLastName

public void setLastName(String lastName)

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

Parameters:

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

getLastName

public String getLastName()

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

Returns:

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

withLastName

public CreateUserRequest withLastName(String lastName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setApiAccess

public void setApiAccess(String 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.

Parameters:

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.

See Also:

ApiAccess

getApiAccess

public String getApiAccess()

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.

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

withApiAccess

public CreateUserRequest withApiAccess(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiAccess

withApiAccess

public CreateUserRequest withApiAccess(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiAccess

setApiAccessPrincipalArn

public void setApiAccessPrincipalArn(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.

Parameters:

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.

getApiAccessPrincipalArn

public String getApiAccessPrincipalArn()

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.

withApiAccessPrincipalArn

public CreateUserRequest withApiAccessPrincipalArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

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

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

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

withClientToken

public CreateUserRequest withClientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateUserRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()