/* * 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.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* A registered user of Amazon QuickSight. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class User implements Serializable, Cloneable, StructuredPojo { /** *

* The Amazon Resource Name (ARN) for the user. *

*/ private String arn; /** *

* The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. *

*/ private String userName; /** *

* The user's email address. *

*/ private String email; /** *

* The Amazon QuickSight role for the user. The user role can be one of the following:. *

* */ private String role; /** *

* The type of identity authentication used by the user. *

*/ private String identityType; /** *

* The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active * Directory user, that user is inactive until they sign in and provide a password. *

*/ private Boolean active; /** *

* The principal ID of the user. *

*/ private String principalId; /** *

* The custom permissions profile associated with this user. *

*/ private String customPermissionsName; /** *

* The type of supported external login provider that provides identity to let the user federate into Amazon * QuickSight with an associated IAM role. The type can be one of the following. *

* */ private String externalLoginFederationProviderType; /** *

* The URL of the external login provider. *

*/ private String externalLoginFederationProviderUrl; /** *

* The identity ID for the user in the external login provider. *

*/ private String externalLoginId; /** *

* The Amazon Resource Name (ARN) for the user. *

* * @param arn * The Amazon Resource Name (ARN) for the user. */ public void setArn(String arn) { this.arn = arn; } /** *

* The Amazon Resource Name (ARN) for the user. *

* * @return The Amazon Resource Name (ARN) for the user. */ public String getArn() { return this.arn; } /** *

* The Amazon Resource Name (ARN) for the user. *

* * @param arn * The Amazon Resource Name (ARN) for the user. * @return Returns a reference to this object so that method calls can be chained together. */ public User withArn(String arn) { setArn(arn); return this; } /** *

* The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. *

* * @param userName * The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. */ public void setUserName(String userName) { this.userName = userName; } /** *

* The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. *

* * @return The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. */ public String getUserName() { return this.userName; } /** *

* The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. *

* * @param userName * The user's user name. This value is required if you are registering a user that will be managed in Amazon * QuickSight. In the output, the value for UserName is N/A when the value for * IdentityType is IAM and the corresponding IAM user is deleted. * @return Returns a reference to this object so that method calls can be chained together. */ public User withUserName(String userName) { setUserName(userName); return this; } /** *

* The user's email address. *

* * @param email * The user's email address. */ public void setEmail(String email) { this.email = email; } /** *

* The user's email address. *

* * @return The user's email address. */ public String getEmail() { return this.email; } /** *

* The user's email address. *

* * @param email * The user's email address. * @return Returns a reference to this object so that method calls can be chained together. */ public User withEmail(String email) { setEmail(email); return this; } /** *

* The Amazon QuickSight role for the user. The user role can be one of the following:. *

* * * @param role * The Amazon QuickSight role for the user. The user role can be one of the following:.

*