com.amazonaws.services.finspacedata.model.CreateUserRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-finspacedata Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.finspacedata.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateUserRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String emailAddress;
/**
*
* 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.
*
*
*
*/
private String type;
/**
*
* The first name of the user that you want to register.
*
*/
private String firstName;
/**
*
* The last name of the user that you want to register.
*
*/
private String lastName;
/**
*
* 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.
*
*
*
*/
private String apiAccess;
/**
*
* 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.
*
*/
private String apiAccessPrincipalArn;
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*/
private String clientToken;
/**
*
* 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.
*
*
* @param 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.
*/
public void setEmailAddress(String emailAddress) {
this.emailAddress = 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.
*
*
* @return 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.
*/
public String getEmailAddress() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withEmailAddress(String emailAddress) {
setEmailAddress(emailAddress);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 UserType
*/
public void setType(String type) {
this.type = 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.
*
*
*
*
* @return 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 UserType
*/
public String getType() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserType
*/
public CreateUserRequest withType(String type) {
setType(type);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserType
*/
public CreateUserRequest withType(UserType type) {
this.type = type.toString();
return this;
}
/**
*
* The first name of the user that you want to register.
*
*
* @param firstName
* The first name of the user that you want to register.
*/
public void setFirstName(String firstName) {
this.firstName = firstName;
}
/**
*
* The first name of the user that you want to register.
*
*
* @return The first name of the user that you want to register.
*/
public String getFirstName() {
return this.firstName;
}
/**
*
* The first name of the user that you want to register.
*
*
* @param firstName
* The first name of the user that you want to register.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withFirstName(String firstName) {
setFirstName(firstName);
return this;
}
/**
*
* The last name of the user that you want to register.
*
*
* @param lastName
* The last name of the user that you want to register.
*/
public void setLastName(String lastName) {
this.lastName = lastName;
}
/**
*
* The last name of the user that you want to register.
*
*
* @return The last name of the user that you want to register.
*/
public String getLastName() {
return this.lastName;
}
/**
*
* The last name of the user that you want to register.
*
*
* @param lastName
* The last name of the user that you want to register.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withLastName(String lastName) {
setLastName(lastName);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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 ApiAccess
*/
public void setApiAccess(String apiAccess) {
this.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.
*
*
*
*
* @return 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 ApiAccess
*/
public String getApiAccess() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiAccess
*/
public CreateUserRequest withApiAccess(String apiAccess) {
setApiAccess(apiAccess);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApiAccess
*/
public CreateUserRequest withApiAccess(ApiAccess apiAccess) {
this.apiAccess = apiAccess.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setApiAccessPrincipalArn(String apiAccessPrincipalArn) {
this.apiAccessPrincipalArn = 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.
*
*
* @return 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.
*/
public String getApiAccessPrincipalArn() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withApiAccessPrincipalArn(String apiAccessPrincipalArn) {
setApiAccessPrincipalArn(apiAccessPrincipalArn);
return this;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @param clientToken
* A token that ensures idempotency. This token expires in 10 minutes.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @return A token that ensures idempotency. This token expires in 10 minutes.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A token that ensures idempotency. This token expires in 10 minutes.
*
*
* @param clientToken
* A token that ensures idempotency. This token expires in 10 minutes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEmailAddress() != null)
sb.append("EmailAddress: ").append("***Sensitive Data Redacted***").append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getFirstName() != null)
sb.append("FirstName: ").append("***Sensitive Data Redacted***").append(",");
if (getLastName() != null)
sb.append("LastName: ").append("***Sensitive Data Redacted***").append(",");
if (getApiAccess() != null)
sb.append("ApiAccess: ").append(getApiAccess()).append(",");
if (getApiAccessPrincipalArn() != null)
sb.append("ApiAccessPrincipalArn: ").append(getApiAccessPrincipalArn()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateUserRequest == false)
return false;
CreateUserRequest other = (CreateUserRequest) obj;
if (other.getEmailAddress() == null ^ this.getEmailAddress() == null)
return false;
if (other.getEmailAddress() != null && other.getEmailAddress().equals(this.getEmailAddress()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getFirstName() == null ^ this.getFirstName() == null)
return false;
if (other.getFirstName() != null && other.getFirstName().equals(this.getFirstName()) == false)
return false;
if (other.getLastName() == null ^ this.getLastName() == null)
return false;
if (other.getLastName() != null && other.getLastName().equals(this.getLastName()) == false)
return false;
if (other.getApiAccess() == null ^ this.getApiAccess() == null)
return false;
if (other.getApiAccess() != null && other.getApiAccess().equals(this.getApiAccess()) == false)
return false;
if (other.getApiAccessPrincipalArn() == null ^ this.getApiAccessPrincipalArn() == null)
return false;
if (other.getApiAccessPrincipalArn() != null && other.getApiAccessPrincipalArn().equals(this.getApiAccessPrincipalArn()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEmailAddress() == null) ? 0 : getEmailAddress().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getFirstName() == null) ? 0 : getFirstName().hashCode());
hashCode = prime * hashCode + ((getLastName() == null) ? 0 : getLastName().hashCode());
hashCode = prime * hashCode + ((getApiAccess() == null) ? 0 : getApiAccess().hashCode());
hashCode = prime * hashCode + ((getApiAccessPrincipalArn() == null) ? 0 : getApiAccessPrincipalArn().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateUserRequest clone() {
return (CreateUserRequest) super.clone();
}
}