Class ListGroupsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListGroupsRequest.Builder,
ListGroupsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The identifier of the application for getting a list of groups mapped to users.static ListGroupsRequest.Builder
builder()
final String
The identifier of the data source for getting a list of groups mapped to users.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
indexId()
The identifier of the index for getting a list of groups mapped to users.final Integer
The maximum number of returned groups that are mapped to users.final String
If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response.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.final Instant
The timestamp identifier used for the latestPUT
orDELETE
action for mapping users to their groups.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationId
The identifier of the application for getting a list of groups mapped to users.
- Returns:
- The identifier of the application for getting a list of groups mapped to users.
-
indexId
The identifier of the index for getting a list of groups mapped to users.
- Returns:
- The identifier of the index for getting a list of groups mapped to users.
-
updatedEarlierThan
The timestamp identifier used for the latest
PUT
orDELETE
action for mapping users to their groups.- Returns:
- The timestamp identifier used for the latest
PUT
orDELETE
action for mapping users to their groups.
-
dataSourceId
The identifier of the data source for getting a list of groups mapped to users.
- Returns:
- The identifier of the data source for getting a list of groups mapped to users.
-
nextToken
If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
- Returns:
- If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.
-
maxResults
The maximum number of returned groups that are mapped to users.
- Returns:
- The maximum number of returned groups that are mapped to users.
-
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 classQBusinessRequest
- 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
-