com.amazonaws.services.workmail.model.CreateUserRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-workmail 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.workmail.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 identifier of the organization for which the user is created.
*
*/
private String organizationId;
/**
*
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum
* length of 20.
*
*/
private String name;
/**
*
* The display name for the new user.
*
*/
private String displayName;
/**
*
* The password for the new user.
*
*/
private String password;
/**
*
* The role of the new user.
*
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected,
* the default role of USER is selected.
*
*/
private String role;
/**
*
* The first name of the new user.
*
*/
private String firstName;
/**
*
* The last name of the new user.
*
*/
private String lastName;
/**
*
* If this parameter is enabled, the user will be hidden from the address book.
*
*/
private Boolean hiddenFromGlobalAddressList;
/**
*
* The identifier of the organization for which the user is created.
*
*
* @param organizationId
* The identifier of the organization for which the user is created.
*/
public void setOrganizationId(String organizationId) {
this.organizationId = organizationId;
}
/**
*
* The identifier of the organization for which the user is created.
*
*
* @return The identifier of the organization for which the user is created.
*/
public String getOrganizationId() {
return this.organizationId;
}
/**
*
* The identifier of the organization for which the user is created.
*
*
* @param organizationId
* The identifier of the organization for which the user is created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withOrganizationId(String organizationId) {
setOrganizationId(organizationId);
return this;
}
/**
*
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum
* length of 20.
*
*
* @param name
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a
* maximum length of 20.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum
* length of 20.
*
*
* @return The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a
* maximum length of 20.
*/
public String getName() {
return this.name;
}
/**
*
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a maximum
* length of 20.
*
*
* @param name
* The name for the new user. WorkMail directory user names have a maximum length of 64. All others have a
* maximum length of 20.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The display name for the new user.
*
*
* @param displayName
* The display name for the new user.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The display name for the new user.
*
*
* @return The display name for the new user.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The display name for the new user.
*
*
* @param displayName
* The display name for the new user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The password for the new user.
*
*
* @param password
* The password for the new user.
*/
public void setPassword(String password) {
this.password = password;
}
/**
*
* The password for the new user.
*
*
* @return The password for the new user.
*/
public String getPassword() {
return this.password;
}
/**
*
* The password for the new user.
*
*
* @param password
* The password for the new user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withPassword(String password) {
setPassword(password);
return this;
}
/**
*
* The role of the new user.
*
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected,
* the default role of USER is selected.
*
*
* @param role
* The role of the new user.
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not
* selected, the default role of USER is selected.
* @see UserRole
*/
public void setRole(String role) {
this.role = role;
}
/**
*
* The role of the new user.
*
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected,
* the default role of USER is selected.
*
*
* @return The role of the new user.
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not
* selected, the default role of USER is selected.
* @see UserRole
*/
public String getRole() {
return this.role;
}
/**
*
* The role of the new user.
*
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected,
* the default role of USER is selected.
*
*
* @param role
* The role of the new user.
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not
* selected, the default role of USER is selected.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserRole
*/
public CreateUserRequest withRole(String role) {
setRole(role);
return this;
}
/**
*
* The role of the new user.
*
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not selected,
* the default role of USER is selected.
*
*
* @param role
* The role of the new user.
*
* You cannot pass SYSTEM_USER or RESOURCE role in a single request. When a user role is not
* selected, the default role of USER is selected.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserRole
*/
public CreateUserRequest withRole(UserRole role) {
this.role = role.toString();
return this;
}
/**
*
* The first name of the new user.
*
*
* @param firstName
* The first name of the new user.
*/
public void setFirstName(String firstName) {
this.firstName = firstName;
}
/**
*
* The first name of the new user.
*
*
* @return The first name of the new user.
*/
public String getFirstName() {
return this.firstName;
}
/**
*
* The first name of the new user.
*
*
* @param firstName
* The first name of the new user.
* @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 new user.
*
*
* @param lastName
* The last name of the new user.
*/
public void setLastName(String lastName) {
this.lastName = lastName;
}
/**
*
* The last name of the new user.
*
*
* @return The last name of the new user.
*/
public String getLastName() {
return this.lastName;
}
/**
*
* The last name of the new user.
*
*
* @param lastName
* The last name of the new user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withLastName(String lastName) {
setLastName(lastName);
return this;
}
/**
*
* If this parameter is enabled, the user will be hidden from the address book.
*
*
* @param hiddenFromGlobalAddressList
* If this parameter is enabled, the user will be hidden from the address book.
*/
public void setHiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList) {
this.hiddenFromGlobalAddressList = hiddenFromGlobalAddressList;
}
/**
*
* If this parameter is enabled, the user will be hidden from the address book.
*
*
* @return If this parameter is enabled, the user will be hidden from the address book.
*/
public Boolean getHiddenFromGlobalAddressList() {
return this.hiddenFromGlobalAddressList;
}
/**
*
* If this parameter is enabled, the user will be hidden from the address book.
*
*
* @param hiddenFromGlobalAddressList
* If this parameter is enabled, the user will be hidden from the address book.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateUserRequest withHiddenFromGlobalAddressList(Boolean hiddenFromGlobalAddressList) {
setHiddenFromGlobalAddressList(hiddenFromGlobalAddressList);
return this;
}
/**
*
* If this parameter is enabled, the user will be hidden from the address book.
*
*
* @return If this parameter is enabled, the user will be hidden from the address book.
*/
public Boolean isHiddenFromGlobalAddressList() {
return this.hiddenFromGlobalAddressList;
}
/**
* 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 (getOrganizationId() != null)
sb.append("OrganizationId: ").append(getOrganizationId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append("***Sensitive Data Redacted***").append(",");
if (getPassword() != null)
sb.append("Password: ").append("***Sensitive Data Redacted***").append(",");
if (getRole() != null)
sb.append("Role: ").append(getRole()).append(",");
if (getFirstName() != null)
sb.append("FirstName: ").append("***Sensitive Data Redacted***").append(",");
if (getLastName() != null)
sb.append("LastName: ").append("***Sensitive Data Redacted***").append(",");
if (getHiddenFromGlobalAddressList() != null)
sb.append("HiddenFromGlobalAddressList: ").append(getHiddenFromGlobalAddressList());
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.getOrganizationId() == null ^ this.getOrganizationId() == null)
return false;
if (other.getOrganizationId() != null && other.getOrganizationId().equals(this.getOrganizationId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getPassword() == null ^ this.getPassword() == null)
return false;
if (other.getPassword() != null && other.getPassword().equals(this.getPassword()) == false)
return false;
if (other.getRole() == null ^ this.getRole() == null)
return false;
if (other.getRole() != null && other.getRole().equals(this.getRole()) == 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.getHiddenFromGlobalAddressList() == null ^ this.getHiddenFromGlobalAddressList() == null)
return false;
if (other.getHiddenFromGlobalAddressList() != null && other.getHiddenFromGlobalAddressList().equals(this.getHiddenFromGlobalAddressList()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOrganizationId() == null) ? 0 : getOrganizationId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getPassword() == null) ? 0 : getPassword().hashCode());
hashCode = prime * hashCode + ((getRole() == null) ? 0 : getRole().hashCode());
hashCode = prime * hashCode + ((getFirstName() == null) ? 0 : getFirstName().hashCode());
hashCode = prime * hashCode + ((getLastName() == null) ? 0 : getLastName().hashCode());
hashCode = prime * hashCode + ((getHiddenFromGlobalAddressList() == null) ? 0 : getHiddenFromGlobalAddressList().hashCode());
return hashCode;
}
@Override
public CreateUserRequest clone() {
return (CreateUserRequest) super.clone();
}
}