software.amazon.awssdk.services.appstream.model

Class DescribeUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appstream.model.AppStreamRequest

software.amazon.awssdk.services.appstream.model.DescribeUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeUsersRequest.Builder,DescribeUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeUsersRequest.Builder

Method Summary

Modifier and Type	Method and Description
AuthenticationType	authenticationType() The authentication type for the users in the user pool to describe.
String	authenticationTypeAsString() The authentication type for the users in the user pool to describe.
static DescribeUsersRequest.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() The maximum size of each page of results.
String	nextToken() The pagination token to use to retrieve the next page of results for this operation.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeUsersRequest.Builder>	serializableBuilderClass()
DescribeUsersRequest.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

authenticationType

public AuthenticationType authenticationType()

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

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

Returns:

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

See Also:

AuthenticationType

authenticationTypeAsString

public String authenticationTypeAsString()

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

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

Returns:

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

See Also:

AuthenticationType

maxResults

public Integer maxResults()

The maximum size of each page of results.

Returns:

The maximum size of each page of results.

nextToken

public String nextToken()

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

toBuilder

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

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static DescribeUsersRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeUsersRequest.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.