software.amazon.awssdk.services.transfer.model

Class ListUsersResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.transfer.model.TransferResponse

software.amazon.awssdk.services.transfer.model.ListUsersResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListUsersResponse
extends TransferResponse
implements ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListUsersResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListUsersResponse.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	nextToken() When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersResponse.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for an SFTP server that the users are assigned to.
ListUsersResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
List<ListedUser>	users() Returns the user accounts and their properties for the ServerId value that you specify.

Methods inherited from class software.amazon.awssdk.services.transfer.model.TransferResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

nextToken

public String nextToken()

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users.

Returns:

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command the NextToken parameter to continue listing additional users.

serverId

public String serverId()

A system-assigned unique identifier for an SFTP server that the users are assigned to.

Returns:

A system-assigned unique identifier for an SFTP server that the users are assigned to.

users

public List<ListedUser> users()

Returns the user accounts and their properties for the ServerId value that you specify.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Returns the user accounts and their properties for the ServerId value that you specify.

toBuilder

public ListUsersResponse.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<ListUsersResponse.Builder,ListUsersResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ListUsersResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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