DescribedUser (AWS SDK for Java

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
```
Returns properties of the user that you wish to describe.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedUser()

Constructors
Constructor and Description
`DescribedUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedUser`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`String`	`getHomeDirectory()` This property 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.
`String`	`getPolicy()` Specifies the name of the policy in use for the described user.
`String`	`getRole()` This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
`List<SshPublicKey>`	`getSshPublicKeys()` This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`List<Tag>`	`getTags()` This property contains the key-value pairs for the user requested.
`String`	`getUserName()` This property is the name of the user that was requested to be described.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`void`	`setHomeDirectory(String homeDirectory)` This property 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`	`setPolicy(String policy)` Specifies the name of the policy in use for the described user.
`void`	`setRole(String role)` This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
`void`	`setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)` This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`void`	`setTags(Collection<Tag> tags)` This property contains the key-value pairs for the user requested.
`void`	`setUserName(String userName)` This property is the name of the user that was requested to be described.
`String`	`toString()` Returns a string representation of this object.
`DescribedUser`	`withArn(String arn)` This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
`DescribedUser`	`withHomeDirectory(String homeDirectory)` This property 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`	`withPolicy(String policy)` Specifies the name of the policy in use for the described user.
`DescribedUser`	`withRole(String role)` This property specifies the IAM role that controls your user's access to your Amazon S3 bucket.
`DescribedUser`	`withSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)` This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`DescribedUser`	`withSshPublicKeys(SshPublicKey... sshPublicKeys)` This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
`DescribedUser`	`withTags(Collection<Tag> tags)` This property contains the key-value pairs for the user requested.
`DescribedUser`	`withTags(Tag... tags)` This property contains the key-value pairs for the user requested.
`DescribedUser`	`withUserName(String userName)` This property is the name of the user that was requested to be described.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedUser
```
public DescribedUser()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Parameters:
    
    arn - This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
  - getArn
```
public String getArn()
```
    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Returns:
    
    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
  - withArn
```
public DescribedUser withArn(String arn)
```
    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
    
    Parameters:
    
    arn - This property contains 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)
```
    This property 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 would be: /bucket_name/home/username .
    
    Parameters:
    
    homeDirectory - This property 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 would be: /bucket_name/home/username .
  - getHomeDirectory
```
public String getHomeDirectory()
```
    This property 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 would be: /bucket_name/home/username .
    
    Returns:
    
    This property 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 would be: /bucket_name/home/username .
  - withHomeDirectory
```
public DescribedUser withHomeDirectory(String homeDirectory)
```
    This property 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 would be: /bucket_name/home/username .
    
    Parameters:
    
    homeDirectory - This property 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 would be: /bucket_name/home/username .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - setRole
```
public void setRole(String role)
```
    This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
    
    Parameters:
    
    role - This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
  - getRole
```
public String getRole()
```
    This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
    
    Returns:
    
    This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
  - withRole
```
public DescribedUser withRole(String role)
```
    This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
    
    Parameters:
    
    role - This property specifies the IAM role that controls your user's 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 the SFTP server to access your resources when servicing your SFTP user's transfer requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSshPublicKeys
```
public List<SshPublicKey> getSshPublicKeys()
```
    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Returns:
    
    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
  - setSshPublicKeys
```
public void setSshPublicKeys(Collection<SshPublicKey> sshPublicKeys)
```
    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Parameters:
    
    sshPublicKeys - This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
  - withSshPublicKeys
```
public DescribedUser withSshPublicKeys(SshPublicKey... sshPublicKeys)
```
    This property contains 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 - This property contains 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)
```
    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
    
    Parameters:
    
    sshPublicKeys - This property contains 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()
```
    This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
    
    Returns:
    
    This property contains 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)
```
    This property contains 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 - This property contains 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)
```
    This property contains 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 - This property contains 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)
```
    This property contains 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 - This property contains 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)
```
    This property is 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 SFTP server.
    
    Parameters:
    
    userName - This property is 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 SFTP server.
  - getUserName
```
public String getUserName()
```
    This property is 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 SFTP server.
    
    Returns:
    
    This property is 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 SFTP server.
  - withUserName
```
public DescribedUser withUserName(String userName)
```
    This property is 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 SFTP server.
    
    Parameters:
    
    userName - This property is 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 SFTP 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)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class DescribedUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedUser

Method Detail

setArn

getArn

withArn

setHomeDirectory

getHomeDirectory

withHomeDirectory

setPolicy

getPolicy

withPolicy

setRole

getRole

withRole

getSshPublicKeys

setSshPublicKeys

withSshPublicKeys

withSshPublicKeys

getTags

setTags

withTags

withTags

setUserName

getUserName

withUserName

toString

equals

hashCode

clone

marshall