software.amazon.awssdk.services.transfer.model

Class ListedUser

java.lang.Object

software.amazon.awssdk.services.transfer.model.ListedUser

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ListedUser.Builder,ListedUser>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListedUser
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ListedUser.Builder,ListedUser>

Returns properties of the user that you specify.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListedUser.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
static ListedUser.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	homeDirectory() Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
HomeDirectoryType	homeDirectoryType() Specifies the type of landing directory (folder) you mapped for your users' home directory.
String	homeDirectoryTypeAsString() Specifies the type of landing directory (folder) you mapped for your users' home directory.
String	role() Specifies the role that is in use by this user.
List<SdkField<?>>	sdkFields()
static Class<? extends ListedUser.Builder>	serializableBuilderClass()
Integer	sshPublicKeyCount() Specifies the number of SSH public keys stored for the user you specified.
ListedUser.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	userName() Specifies the name of the user whose ARN was specified.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

Returns:

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

homeDirectory

public final String homeDirectory()

Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Returns:

Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

homeDirectoryType

public final HomeDirectoryType homeDirectoryType()

Specifies 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 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 paths visible to your users.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

Specifies 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 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 paths visible to your users.

See Also:

HomeDirectoryType

homeDirectoryTypeAsString

public final String homeDirectoryTypeAsString()

Specifies 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 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 paths visible to your users.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

Specifies 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 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 paths visible to your users.

See Also:

HomeDirectoryType

role

public final String role()

Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled 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:

Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled 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.

sshPublicKeyCount

public final Integer sshPublicKeyCount()

Specifies the number of SSH public keys stored for the user you specified.

Returns:

Specifies the number of SSH public keys stored for the user you specified.

userName

public final String userName()

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Returns:

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

toBuilder

public ListedUser.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListedUser.Builder,ListedUser>

Returns:

a builder for type T

builder

public static ListedUser.Builder builder()

serializableBuilderClass

public static Class<? extends ListedUser.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.