Package 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("software.amazon.awssdk:codegen")
public final class ListUsersResponse
extends TransferResponse
implements ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListUsersResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListUsersResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUsers()	For responses, this returns true if the service returned a value for the Users property.
String	nextToken()	When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersResponse.Builder>	serializableBuilderClass()
String	serverId()	A system-assigned unique identifier for a server that the users are assigned to.
ListUsersResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<ListedUser>	users()	Returns the Transfer Family users 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

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

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

copy

Method Detail

nextToken

public final 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 to 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 to the NextToken parameter to continue listing additional users.

serverId

public final String serverId()

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

Returns:

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

hasUsers

public final boolean hasUsers()

For responses, this returns true if the service returned a value for the Users property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

users

public final List<ListedUser> users()

Returns the Transfer Family users and their properties for the ServerId value that you specify.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUsers() method.

Returns:

Returns the Transfer Family users and their properties for the ServerId value that you specify.

toBuilder

public ListUsersResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUsersResponse.Builder,ListUsersResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListUsersResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo