Class ListGroupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListGroupsRequest.Builder,
ListGroupsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListGroupsRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.filters()
Deprecated.Using filters with ListGroups API is deprecated, please use GetGroupId API instead.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
Deprecated.Using filters with ListGroups API is deprecated, please use GetGroupId API instead.final int
hashCode()
final String
The globally unique identifier for the identity store, such asd-1234567890
.final Integer
The maximum number of results to be returned per request.final String
The pagination token used for theListUsers
andListGroups
API operations.static Class
<? extends ListGroupsRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
identityStoreId
The globally unique identifier for the identity store, such as
d-1234567890
. In this example,d-
is a fixed prefix, and1234567890
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, and1234567890
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
The maximum number of results to be returned per request. This parameter is used in the
ListUsers
andListGroups
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
andListGroups
requests to specify how many results to return in one page. The length limit is 50 characters.
-
nextToken
The pagination token used for the
ListUsers
andListGroups
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
andListGroups
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.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 theisEmpty()
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.Using filters with ListGroups API is deprecated, please use GetGroupId API instead.A list of
Filter
objects, which is used in theListUsers
andListGroups
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 theListUsers
andListGroups
requests.
-
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 interfaceToCopyableBuilder<ListGroupsRequest.Builder,
ListGroupsRequest> - Specified by:
toBuilder
in classIdentitystoreRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-