com.amazonaws.services.transfer.model

Class DescribedUser

java.lang.Object

com.amazonaws.services.transfer.model.DescribedUser

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Describes the properties of a user that was specified.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribedUser()

Method Summary

Modifier and Type	Method and Description
DescribedUser	clone()
boolean	equals(Object obj)
String	getArn() Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
String	getHomeDirectory() Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user.
List<HomeDirectoryMapEntry>	getHomeDirectoryMappings() Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible.
String	getHomeDirectoryType() Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
String	getPolicy() Specifies the name of the policy in use for the described user.
PosixProfile	getPosixProfile() Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
String	getRole() The IAM role that controls your users' access to your Amazon S3 bucket.
List<SshPublicKey>	getSshPublicKeys() Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
List<Tag>	getTags() Specifies the key-value pairs for the user requested.
String	getUserName() Specifies the name of the user that was requested to be described.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setArn(String arn) Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
void	setHomeDirectory(String homeDirectory) Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user.
void	setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible.
void	setHomeDirectoryType(String homeDirectoryType) Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
void	setPolicy(String policy) Specifies the name of the policy in use for the described user.
void	setPosixProfile(PosixProfile posixProfile) Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
void	setRole(String role) The IAM role that controls your users' access to your Amazon S3 bucket.
void	setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
void	setTags(Collection<Tag> tags) Specifies the key-value pairs for the user requested.
void	setUserName(String userName) Specifies the name of the user that was requested to be described.
String	toString() Returns a string representation of this object.
DescribedUser	withArn(String arn) Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
DescribedUser	withHomeDirectory(String homeDirectory) Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user.
DescribedUser	withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible.
DescribedUser	withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings) Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible.
DescribedUser	withHomeDirectoryType(HomeDirectoryType homeDirectoryType) Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
DescribedUser	withHomeDirectoryType(String homeDirectoryType) Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.
DescribedUser	withPolicy(String policy) Specifies the name of the policy in use for the described user.
DescribedUser	withPosixProfile(PosixProfile posixProfile) Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
DescribedUser	withRole(String role) The IAM role that controls your users' access to your Amazon S3 bucket.
DescribedUser	withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser	withSshPublicKeys(SshPublicKey... sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser	withTags(Collection<Tag> tags) Specifies the key-value pairs for the user requested.
DescribedUser	withTags(Tag... tags) Specifies the key-value pairs for the user requested.
DescribedUser	withUserName(String userName) Specifies the name of the user that was requested to be described.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribedUser

public DescribedUser()

Method Detail

setArn

public void setArn(String arn)

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

getArn

public String getArn()

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

withArn

public DescribedUser withArn(String arn)

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

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

setHomeDirectory

public void setHomeDirectory(String homeDirectory)

Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

Parameters:

homeDirectory - Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

getHomeDirectory

public String getHomeDirectory()

Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

Returns:

Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

withHomeDirectory

public DescribedUser withHomeDirectory(String homeDirectory)

Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

Parameters:

homeDirectory - Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username .

Returns:

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

getHomeDirectoryMappings

public List<HomeDirectoryMapEntry> getHomeDirectoryMappings()

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and " Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target .

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

setHomeDirectoryMappings

public void setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and " Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target .

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

withHomeDirectoryMappings

public DescribedUser withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and " Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target .

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

NOTE: This method appends the values to the existing list (if any). Use setHomeDirectoryMappings(java.util.Collection) or withHomeDirectoryMappings(java.util.Collection) if you want to override the existing values.

Parameters:

homeDirectoryMappings - Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

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

withHomeDirectoryMappings

public DescribedUser withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)

Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry" and " Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target .

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Specifies the logical directory mappings that specify what Amazon S3 or EFS paths and keys should be visible to your user and how you want to make them visible. You will need to specify the " Entry" and "Target" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or EFS path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

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

setHomeDirectoryType

public void setHomeDirectoryType(String homeDirectoryType)

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Parameters:

homeDirectoryType - Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

See Also:

HomeDirectoryType

getHomeDirectoryType

public String getHomeDirectoryType()

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Returns:

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

See Also:

HomeDirectoryType

withHomeDirectoryType

public DescribedUser withHomeDirectoryType(String homeDirectoryType)

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Parameters:

homeDirectoryType - Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Returns:

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

See Also:

HomeDirectoryType

withHomeDirectoryType

public DescribedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Parameters:

homeDirectoryType - Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

Returns:

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

See Also:

HomeDirectoryType

setPolicy

public void setPolicy(String policy)

Specifies the name of the policy in use for the described user.

Parameters:

policy - Specifies the name of the policy in use for the described user.

getPolicy

public String getPolicy()

Specifies the name of the policy in use for the described user.

Returns:

Specifies the name of the policy in use for the described user.

withPolicy

public DescribedUser withPolicy(String policy)

Specifies the name of the policy in use for the described user.

Parameters:

policy - Specifies the name of the policy in use for the described user.

Returns:

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

setPosixProfile

public void setPosixProfile(PosixProfile posixProfile)

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Parameters:

posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

getPosixProfile

public PosixProfile getPosixProfile()

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Returns:

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

withPosixProfile

public DescribedUser withPosixProfile(PosixProfile posixProfile)

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Parameters:

posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Returns:

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

setRole

public void setRole(String role)

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

Parameters:

role - The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

getRole

public String getRole()

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

Returns:

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

withRole

public DescribedUser withRole(String role)

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

Parameters:

role - The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing your users' transfer requests.

Returns:

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

getSshPublicKeys

public List<SshPublicKey> getSshPublicKeys()

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

setSshPublicKeys

public void setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Parameters:

sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

withSshPublicKeys

public DescribedUser withSshPublicKeys(SshPublicKey... sshPublicKeys)

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

NOTE: This method appends the values to the existing list (if any). Use setSshPublicKeys(java.util.Collection) or withSshPublicKeys(java.util.Collection) if you want to override the existing values.

Parameters:

sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

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

withSshPublicKeys

public DescribedUser withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Parameters:

sshPublicKeys - Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

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

getTags

public List<Tag> getTags()

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

setTags

public void setTags(Collection<Tag> tags)

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Parameters:

tags - Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

withTags

public DescribedUser withTags(Tag... tags)

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

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

withTags

public DescribedUser withTags(Collection<Tag> tags)

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Parameters:

tags - Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

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

setUserName

public void setUserName(String userName)

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

Parameters:

userName - Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

getUserName

public String getUserName()

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

Returns:

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

withUserName

public DescribedUser withUserName(String userName)

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

Parameters:

userName - Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

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 DescribedUser clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo