software.amazon.awssdk.services.identitystore.model

Class ListUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.identitystore.model.IdentitystoreRequest

software.amazon.awssdk.services.identitystore.model.ListUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListUsersRequest
extends IdentitystoreRequest
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)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters() A list of Filter objects, which is used in the ListUsers and ListGroups request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters() Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
String	identityStoreId() The globally unique identifier for the identity store, such as d-1234567890.
Integer	maxResults() The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page.
String	nextToken() The pagination token used for the ListUsers and ListGroups APIs.
List<SdkField<?>>	sdkFields()
static Class<? extends ListUsersRequest.Builder>	serializableBuilderClass()
ListUsersRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

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

identityStoreId

public String identityStoreId()

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

Returns:

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.

maxResults

public Integer maxResults()

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

Returns:

The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

nextToken

public String nextToken()

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

Returns:

The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.

hasFilters

public boolean hasFilters()

Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

filters

public List<Filter> filters()

A list of Filter objects, which is used in the ListUsers and ListGroups request.

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

You can use hasFilters() to see if a value was sent in this field.

Returns:

A list of Filter objects, which is used in the ListUsers and ListGroups request.

toBuilder

public ListUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListUsersRequest.Builder,ListUsersRequest>

Specified by:

toBuilder in class IdentitystoreRequest

builder

public static ListUsersRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo