software.amazon.awssdk.services.transfer.model

Class ListUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.ListUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListUsersRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListUsersRequest.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 SdkRequest.
int	hashCode()
Integer	maxResults() Specifies the number of users to return as a response to the ListUsers request.
String	nextToken() When you can get additional results from the ListUsersListUsers call, a NextToken parameter is returned in the output.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.
ListUsersRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

maxResults

public Integer maxResults()

Specifies the number of users to return as a response to the ListUsers request.

Returns:

Specifies the number of users to return as a response to the ListUsers request.

nextToken

public String nextToken()

When you can get additional results from the ListUsersListUsers 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 ListUsersListUsers 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 a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.

Returns:

A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users are assigned to it.

toBuilder

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

Specified by:

toBuilder in class TransferRequest

Returns:

a builder for type T

builder

public static ListUsersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListUsersRequest.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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.