com.amazonaws.services.chime.model.User Maven / Gradle / Ivy
Show all versions of aws-java-sdk-chime Show documentation
/*
* Copyright 2018-2023 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.chime.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The user on the Amazon Chime account.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class User implements Serializable, Cloneable, StructuredPojo {
/**
*
* The user ID.
*
*/
private String userId;
/**
*
* The Amazon Chime account ID.
*
*/
private String accountId;
/**
*
* The primary email address of the user.
*
*/
private String primaryEmail;
/**
*
* The primary phone number associated with the user.
*
*/
private String primaryProvisionedNumber;
/**
*
* The display name of the user.
*
*/
private String displayName;
/**
*
* The license type for the user.
*
*/
private String licenseType;
/**
*
* The user type.
*
*/
private String userType;
/**
*
* The user registration status.
*
*/
private String userRegistrationStatus;
/**
*
* The user invite status.
*
*/
private String userInvitationStatus;
/**
*
* Date and time when the user is registered, in ISO 8601 format.
*
*/
private java.util.Date registeredOn;
/**
*
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*
*/
private java.util.Date invitedOn;
/**
*
* The Alexa for Business metadata.
*
*/
private AlexaForBusinessMetadata alexaForBusinessMetadata;
/**
*
* The user's personal meeting PIN.
*
*/
private String personalPIN;
/**
*
* The user ID.
*
*
* @param userId
* The user ID.
*/
public void setUserId(String userId) {
this.userId = userId;
}
/**
*
* The user ID.
*
*
* @return The user ID.
*/
public String getUserId() {
return this.userId;
}
/**
*
* The user ID.
*
*
* @param userId
* The user ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withUserId(String userId) {
setUserId(userId);
return this;
}
/**
*
* The Amazon Chime account ID.
*
*
* @param accountId
* The Amazon Chime account ID.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The Amazon Chime account ID.
*
*
* @return The Amazon Chime account ID.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The Amazon Chime account ID.
*
*
* @param accountId
* The Amazon Chime account ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* The primary email address of the user.
*
*
* @param primaryEmail
* The primary email address of the user.
*/
public void setPrimaryEmail(String primaryEmail) {
this.primaryEmail = primaryEmail;
}
/**
*
* The primary email address of the user.
*
*
* @return The primary email address of the user.
*/
public String getPrimaryEmail() {
return this.primaryEmail;
}
/**
*
* The primary email address of the user.
*
*
* @param primaryEmail
* The primary email address of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withPrimaryEmail(String primaryEmail) {
setPrimaryEmail(primaryEmail);
return this;
}
/**
*
* The primary phone number associated with the user.
*
*
* @param primaryProvisionedNumber
* The primary phone number associated with the user.
*/
public void setPrimaryProvisionedNumber(String primaryProvisionedNumber) {
this.primaryProvisionedNumber = primaryProvisionedNumber;
}
/**
*
* The primary phone number associated with the user.
*
*
* @return The primary phone number associated with the user.
*/
public String getPrimaryProvisionedNumber() {
return this.primaryProvisionedNumber;
}
/**
*
* The primary phone number associated with the user.
*
*
* @param primaryProvisionedNumber
* The primary phone number associated with the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withPrimaryProvisionedNumber(String primaryProvisionedNumber) {
setPrimaryProvisionedNumber(primaryProvisionedNumber);
return this;
}
/**
*
* The display name of the user.
*
*
* @param displayName
* The display name of the user.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The display name of the user.
*
*
* @return The display name of the user.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The display name of the user.
*
*
* @param displayName
* The display name of the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The license type for the user.
*
*
* @param licenseType
* The license type for the user.
* @see License
*/
public void setLicenseType(String licenseType) {
this.licenseType = licenseType;
}
/**
*
* The license type for the user.
*
*
* @return The license type for the user.
* @see License
*/
public String getLicenseType() {
return this.licenseType;
}
/**
*
* The license type for the user.
*
*
* @param licenseType
* The license type for the user.
* @return Returns a reference to this object so that method calls can be chained together.
* @see License
*/
public User withLicenseType(String licenseType) {
setLicenseType(licenseType);
return this;
}
/**
*
* The license type for the user.
*
*
* @param licenseType
* The license type for the user.
* @return Returns a reference to this object so that method calls can be chained together.
* @see License
*/
public User withLicenseType(License licenseType) {
this.licenseType = licenseType.toString();
return this;
}
/**
*
* The user type.
*
*
* @param userType
* The user type.
* @see UserType
*/
public void setUserType(String userType) {
this.userType = userType;
}
/**
*
* The user type.
*
*
* @return The user type.
* @see UserType
*/
public String getUserType() {
return this.userType;
}
/**
*
* The user type.
*
*
* @param userType
* The user type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserType
*/
public User withUserType(String userType) {
setUserType(userType);
return this;
}
/**
*
* The user type.
*
*
* @param userType
* The user type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see UserType
*/
public User withUserType(UserType userType) {
this.userType = userType.toString();
return this;
}
/**
*
* The user registration status.
*
*
* @param userRegistrationStatus
* The user registration status.
* @see RegistrationStatus
*/
public void setUserRegistrationStatus(String userRegistrationStatus) {
this.userRegistrationStatus = userRegistrationStatus;
}
/**
*
* The user registration status.
*
*
* @return The user registration status.
* @see RegistrationStatus
*/
public String getUserRegistrationStatus() {
return this.userRegistrationStatus;
}
/**
*
* The user registration status.
*
*
* @param userRegistrationStatus
* The user registration status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RegistrationStatus
*/
public User withUserRegistrationStatus(String userRegistrationStatus) {
setUserRegistrationStatus(userRegistrationStatus);
return this;
}
/**
*
* The user registration status.
*
*
* @param userRegistrationStatus
* The user registration status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see RegistrationStatus
*/
public User withUserRegistrationStatus(RegistrationStatus userRegistrationStatus) {
this.userRegistrationStatus = userRegistrationStatus.toString();
return this;
}
/**
*
* The user invite status.
*
*
* @param userInvitationStatus
* The user invite status.
* @see InviteStatus
*/
public void setUserInvitationStatus(String userInvitationStatus) {
this.userInvitationStatus = userInvitationStatus;
}
/**
*
* The user invite status.
*
*
* @return The user invite status.
* @see InviteStatus
*/
public String getUserInvitationStatus() {
return this.userInvitationStatus;
}
/**
*
* The user invite status.
*
*
* @param userInvitationStatus
* The user invite status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InviteStatus
*/
public User withUserInvitationStatus(String userInvitationStatus) {
setUserInvitationStatus(userInvitationStatus);
return this;
}
/**
*
* The user invite status.
*
*
* @param userInvitationStatus
* The user invite status.
* @return Returns a reference to this object so that method calls can be chained together.
* @see InviteStatus
*/
public User withUserInvitationStatus(InviteStatus userInvitationStatus) {
this.userInvitationStatus = userInvitationStatus.toString();
return this;
}
/**
*
* Date and time when the user is registered, in ISO 8601 format.
*
*
* @param registeredOn
* Date and time when the user is registered, in ISO 8601 format.
*/
public void setRegisteredOn(java.util.Date registeredOn) {
this.registeredOn = registeredOn;
}
/**
*
* Date and time when the user is registered, in ISO 8601 format.
*
*
* @return Date and time when the user is registered, in ISO 8601 format.
*/
public java.util.Date getRegisteredOn() {
return this.registeredOn;
}
/**
*
* Date and time when the user is registered, in ISO 8601 format.
*
*
* @param registeredOn
* Date and time when the user is registered, in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withRegisteredOn(java.util.Date registeredOn) {
setRegisteredOn(registeredOn);
return this;
}
/**
*
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*
*
* @param invitedOn
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*/
public void setInvitedOn(java.util.Date invitedOn) {
this.invitedOn = invitedOn;
}
/**
*
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*
*
* @return Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*/
public java.util.Date getInvitedOn() {
return this.invitedOn;
}
/**
*
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*
*
* @param invitedOn
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withInvitedOn(java.util.Date invitedOn) {
setInvitedOn(invitedOn);
return this;
}
/**
*
* The Alexa for Business metadata.
*
*
* @param alexaForBusinessMetadata
* The Alexa for Business metadata.
*/
public void setAlexaForBusinessMetadata(AlexaForBusinessMetadata alexaForBusinessMetadata) {
this.alexaForBusinessMetadata = alexaForBusinessMetadata;
}
/**
*
* The Alexa for Business metadata.
*
*
* @return The Alexa for Business metadata.
*/
public AlexaForBusinessMetadata getAlexaForBusinessMetadata() {
return this.alexaForBusinessMetadata;
}
/**
*
* The Alexa for Business metadata.
*
*
* @param alexaForBusinessMetadata
* The Alexa for Business metadata.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withAlexaForBusinessMetadata(AlexaForBusinessMetadata alexaForBusinessMetadata) {
setAlexaForBusinessMetadata(alexaForBusinessMetadata);
return this;
}
/**
*
* The user's personal meeting PIN.
*
*
* @param personalPIN
* The user's personal meeting PIN.
*/
public void setPersonalPIN(String personalPIN) {
this.personalPIN = personalPIN;
}
/**
*
* The user's personal meeting PIN.
*
*
* @return The user's personal meeting PIN.
*/
public String getPersonalPIN() {
return this.personalPIN;
}
/**
*
* The user's personal meeting PIN.
*
*
* @param personalPIN
* The user's personal meeting PIN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public User withPersonalPIN(String personalPIN) {
setPersonalPIN(personalPIN);
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 (getUserId() != null)
sb.append("UserId: ").append(getUserId()).append(",");
if (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getPrimaryEmail() != null)
sb.append("PrimaryEmail: ").append("***Sensitive Data Redacted***").append(",");
if (getPrimaryProvisionedNumber() != null)
sb.append("PrimaryProvisionedNumber: ").append("***Sensitive Data Redacted***").append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append("***Sensitive Data Redacted***").append(",");
if (getLicenseType() != null)
sb.append("LicenseType: ").append(getLicenseType()).append(",");
if (getUserType() != null)
sb.append("UserType: ").append(getUserType()).append(",");
if (getUserRegistrationStatus() != null)
sb.append("UserRegistrationStatus: ").append(getUserRegistrationStatus()).append(",");
if (getUserInvitationStatus() != null)
sb.append("UserInvitationStatus: ").append(getUserInvitationStatus()).append(",");
if (getRegisteredOn() != null)
sb.append("RegisteredOn: ").append(getRegisteredOn()).append(",");
if (getInvitedOn() != null)
sb.append("InvitedOn: ").append(getInvitedOn()).append(",");
if (getAlexaForBusinessMetadata() != null)
sb.append("AlexaForBusinessMetadata: ").append(getAlexaForBusinessMetadata()).append(",");
if (getPersonalPIN() != null)
sb.append("PersonalPIN: ").append(getPersonalPIN());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof User == false)
return false;
User other = (User) obj;
if (other.getUserId() == null ^ this.getUserId() == null)
return false;
if (other.getUserId() != null && other.getUserId().equals(this.getUserId()) == false)
return false;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getPrimaryEmail() == null ^ this.getPrimaryEmail() == null)
return false;
if (other.getPrimaryEmail() != null && other.getPrimaryEmail().equals(this.getPrimaryEmail()) == false)
return false;
if (other.getPrimaryProvisionedNumber() == null ^ this.getPrimaryProvisionedNumber() == null)
return false;
if (other.getPrimaryProvisionedNumber() != null && other.getPrimaryProvisionedNumber().equals(this.getPrimaryProvisionedNumber()) == 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.getLicenseType() == null ^ this.getLicenseType() == null)
return false;
if (other.getLicenseType() != null && other.getLicenseType().equals(this.getLicenseType()) == false)
return false;
if (other.getUserType() == null ^ this.getUserType() == null)
return false;
if (other.getUserType() != null && other.getUserType().equals(this.getUserType()) == false)
return false;
if (other.getUserRegistrationStatus() == null ^ this.getUserRegistrationStatus() == null)
return false;
if (other.getUserRegistrationStatus() != null && other.getUserRegistrationStatus().equals(this.getUserRegistrationStatus()) == false)
return false;
if (other.getUserInvitationStatus() == null ^ this.getUserInvitationStatus() == null)
return false;
if (other.getUserInvitationStatus() != null && other.getUserInvitationStatus().equals(this.getUserInvitationStatus()) == false)
return false;
if (other.getRegisteredOn() == null ^ this.getRegisteredOn() == null)
return false;
if (other.getRegisteredOn() != null && other.getRegisteredOn().equals(this.getRegisteredOn()) == false)
return false;
if (other.getInvitedOn() == null ^ this.getInvitedOn() == null)
return false;
if (other.getInvitedOn() != null && other.getInvitedOn().equals(this.getInvitedOn()) == false)
return false;
if (other.getAlexaForBusinessMetadata() == null ^ this.getAlexaForBusinessMetadata() == null)
return false;
if (other.getAlexaForBusinessMetadata() != null && other.getAlexaForBusinessMetadata().equals(this.getAlexaForBusinessMetadata()) == false)
return false;
if (other.getPersonalPIN() == null ^ this.getPersonalPIN() == null)
return false;
if (other.getPersonalPIN() != null && other.getPersonalPIN().equals(this.getPersonalPIN()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserId() == null) ? 0 : getUserId().hashCode());
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getPrimaryEmail() == null) ? 0 : getPrimaryEmail().hashCode());
hashCode = prime * hashCode + ((getPrimaryProvisionedNumber() == null) ? 0 : getPrimaryProvisionedNumber().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getLicenseType() == null) ? 0 : getLicenseType().hashCode());
hashCode = prime * hashCode + ((getUserType() == null) ? 0 : getUserType().hashCode());
hashCode = prime * hashCode + ((getUserRegistrationStatus() == null) ? 0 : getUserRegistrationStatus().hashCode());
hashCode = prime * hashCode + ((getUserInvitationStatus() == null) ? 0 : getUserInvitationStatus().hashCode());
hashCode = prime * hashCode + ((getRegisteredOn() == null) ? 0 : getRegisteredOn().hashCode());
hashCode = prime * hashCode + ((getInvitedOn() == null) ? 0 : getInvitedOn().hashCode());
hashCode = prime * hashCode + ((getAlexaForBusinessMetadata() == null) ? 0 : getAlexaForBusinessMetadata().hashCode());
hashCode = prime * hashCode + ((getPersonalPIN() == null) ? 0 : getPersonalPIN().hashCode());
return hashCode;
}
@Override
public User clone() {
try {
return (User) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.chime.model.transform.UserMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}