Package software.amazon.awssdk.services.identitystore.model

Class ListGroupsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListGroupsRequest
extends IdentitystoreRequest
implements ToCopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListGroupsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListGroupsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	Deprecated. Using filters with ListGroups API is deprecated, please use GetGroupId API instead.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	Deprecated. Using filters with ListGroups API is deprecated, please use GetGroupId API instead.
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.
String	nextToken()	The pagination token used for the ListUsers and ListGroups API operations.
List<SdkField<?>>	sdkFields()
static Class<? extends ListGroupsRequest.Builder>	serializableBuilderClass()
ListGroupsRequest.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 final 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 that contains numbers 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 that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

maxResults

public final Integer maxResults()

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests 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. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

nextToken

public final String nextToken()

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

Returns:

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

hasFilters

@Deprecated
public final boolean hasFilters()

Deprecated.

Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

For responses, this returns true if the service returned a value for the Filters 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.

filters

@Deprecated
public final List<Filter> filters()

Deprecated.

Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

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

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 hasFilters() method.

Returns:

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

toBuilder

public ListGroupsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListGroupsRequest.Builder,ListGroupsRequest>

Specified by:

toBuilder in class IdentitystoreRequest

builder

public static ListGroupsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo