ListedUser (AWS Java SDK for AWS Transfer for SFTP 1.11.699 API)

java.lang.Object
- com.amazonaws.services.transfer.model.ListedUser

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListedUser
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Returns properties of the user that you specify.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ListedUser()

Constructors
Constructor and Description
`ListedUser()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListedUser`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
`String`	`getHomeDirectory()` This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
`String`	`getHomeDirectoryType()` The type of landing directory (folder) you mapped for your users' home directory.
`String`	`getRole()` The role in use by this user.
`Integer`	`getSshPublicKeyCount()` This value is the number of SSH public keys stored for the user you specified.
`String`	`getUserName()` The name of the user whose ARN was specified.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setArn(String arn)` This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
`void`	`setHomeDirectory(String homeDirectory)` This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
`void`	`setHomeDirectoryType(String homeDirectoryType)` The type of landing directory (folder) you mapped for your users' home directory.
`void`	`setRole(String role)` The role in use by this user.
`void`	`setSshPublicKeyCount(Integer sshPublicKeyCount)` This value is the number of SSH public keys stored for the user you specified.
`void`	`setUserName(String userName)` The name of the user whose ARN was specified.
`String`	`toString()` Returns a string representation of this object.
`ListedUser`	`withArn(String arn)` This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
`ListedUser`	`withHomeDirectory(String homeDirectory)` This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
`ListedUser`	`withHomeDirectoryType(HomeDirectoryType homeDirectoryType)` The type of landing directory (folder) you mapped for your users' home directory.
`ListedUser`	`withHomeDirectoryType(String homeDirectoryType)` The type of landing directory (folder) you mapped for your users' home directory.
`ListedUser`	`withRole(String role)` The role in use by this user.
`ListedUser`	`withSshPublicKeyCount(Integer sshPublicKeyCount)` This value is the number of SSH public keys stored for the user you specified.
`ListedUser`	`withUserName(String userName)` The name of the user whose ARN was specified.

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

- Constructor Detail
  - ListedUser
```
public ListedUser()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
    
    Parameters:
    
    arn - This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
  - getArn
```
public String getArn()
```
    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
    
    Returns:
    
    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
  - withArn
```
public ListedUser withArn(String arn)
```
    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
    
    Parameters:
    
    arn - This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHomeDirectory
```
public void setHomeDirectory(String homeDirectory)
```
    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
    
    Parameters:
    
    homeDirectory - This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
  - getHomeDirectory
```
public String getHomeDirectory()
```
    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
    
    Returns:
    
    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
  - withHomeDirectory
```
public ListedUser withHomeDirectory(String homeDirectory)
```
    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
    
    Parameters:
    
    homeDirectory - This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHomeDirectoryType
```
public void setHomeDirectoryType(String homeDirectoryType)
```
    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    See Also:
    
    HomeDirectoryType
  - getHomeDirectoryType
```
public String getHomeDirectoryType()
```
    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Returns:
    
    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    See Also:
    
    HomeDirectoryType
  - withHomeDirectoryType
```
public ListedUser withHomeDirectoryType(String homeDirectoryType)
```
    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HomeDirectoryType
  - withHomeDirectoryType
```
public ListedUser withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
```
    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Parameters:
    
    homeDirectoryType - The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HomeDirectoryType
  - setRole
```
public void setRole(String role)
```
    The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
    
    Parameters:
    
    role - The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
  - getRole
```
public String getRole()
```
    The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
    
    Returns:
    
    The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
  - withRole
```
public ListedUser withRole(String role)
```
    The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
    
    Parameters:
    
    role - The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSshPublicKeyCount
```
public void setSshPublicKeyCount(Integer sshPublicKeyCount)
```
    This value is the number of SSH public keys stored for the user you specified.
    
    Parameters:
    
    sshPublicKeyCount - This value is the number of SSH public keys stored for the user you specified.
  - getSshPublicKeyCount
```
public Integer getSshPublicKeyCount()
```
    This value is the number of SSH public keys stored for the user you specified.
    
    Returns:
    
    This value is the number of SSH public keys stored for the user you specified.
  - withSshPublicKeyCount
```
public ListedUser withSshPublicKeyCount(Integer sshPublicKeyCount)
```
    This value is the number of SSH public keys stored for the user you specified.
    
    Parameters:
    
    sshPublicKeyCount - This value is the number of SSH public keys stored for the user you specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The name of the user whose ARN was specified. User names are used for authentication purposes.
    
    Parameters:
    
    userName - The name of the user whose ARN was specified. User names are used for authentication purposes.
  - getUserName
```
public String getUserName()
```
    The name of the user whose ARN was specified. User names are used for authentication purposes.
    
    Returns:
    
    The name of the user whose ARN was specified. User names are used for authentication purposes.
  - withUserName
```
public ListedUser withUserName(String userName)
```
    The name of the user whose ARN was specified. User names are used for authentication purposes.
    
    Parameters:
    
    userName - The name of the user whose ARN was specified. User names are used for authentication purposes.
    
    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 ListedUser clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class ListedUser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListedUser

Method Detail

setArn

getArn

withArn

setHomeDirectory

getHomeDirectory

withHomeDirectory

setHomeDirectoryType

getHomeDirectoryType

withHomeDirectoryType

withHomeDirectoryType

setRole

getRole

withRole

setSshPublicKeyCount

getSshPublicKeyCount

withSshPublicKeyCount

setUserName

getUserName

withUserName

toString

equals

hashCode

clone

marshall