Interface SearchGroupsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>,DirectoryServiceDataRequest.Builder,SdkBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- SearchGroupsRequest
public static interface SearchGroupsRequest.Builder extends DirectoryServiceDataRequest.Builder, SdkPojo, CopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SearchGroupsRequest.BuilderdirectoryId(String directoryId)The identifier (ID) of the directory that's associated with the group.SearchGroupsRequest.BuildermaxResults(Integer maxResults)The maximum number of results to be returned per request.SearchGroupsRequest.BuildernextToken(String nextToken)An encoded paging token for paginated calls that can be passed back to retrieve the next page.SearchGroupsRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SearchGroupsRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)SearchGroupsRequest.Builderrealm(String realm)The domain name that's associated with the group.SearchGroupsRequest.BuildersearchAttributes(String... searchAttributes)One or more data attributes that are used to search for a group.SearchGroupsRequest.BuildersearchAttributes(Collection<String> searchAttributes)One or more data attributes that are used to search for a group.SearchGroupsRequest.BuildersearchString(String searchString)The attribute value that you want to search for.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.directoryservicedata.model.DirectoryServiceDataRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
directoryId
SearchGroupsRequest.Builder directoryId(String directoryId)
The identifier (ID) of the directory that's associated with the group.
- Parameters:
directoryId- The identifier (ID) of the directory that's associated with the group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
SearchGroupsRequest.Builder maxResults(Integer maxResults)
The maximum number of results to be returned per request.
- Parameters:
maxResults- The maximum number of results to be returned per request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
SearchGroupsRequest.Builder nextToken(String nextToken)
An encoded paging token for paginated calls that can be passed back to retrieve the next page.
- Parameters:
nextToken- An encoded paging token for paginated calls that can be passed back to retrieve the next page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
realm
SearchGroupsRequest.Builder realm(String realm)
The domain name that's associated with the group.
This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.
This value is case insensitive.
- Parameters:
realm- The domain name that's associated with the group.This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned.
This value is case insensitive.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchAttributes
SearchGroupsRequest.Builder searchAttributes(Collection<String> searchAttributes)
One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.
- Parameters:
searchAttributes- One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchAttributes
SearchGroupsRequest.Builder searchAttributes(String... searchAttributes)
One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.
- Parameters:
searchAttributes- One or more data attributes that are used to search for a group. For a list of supported attributes, see Directory Service Data Attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
searchString
SearchGroupsRequest.Builder searchString(String searchString)
The attribute value that you want to search for.
Wildcard
(*)searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.- Parameters:
searchString- The attribute value that you want to search for.Wildcard
(*)searches aren't supported. For a list of supported attributes, see Directory Service Data Attributes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SearchGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SearchGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-