Interface SearchUserHierarchyGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SearchUserHierarchyGroupsRequest.Builder,SearchUserHierarchyGroupsRequest>, SdkBuilder<SearchUserHierarchyGroupsRequest.Builder,SearchUserHierarchyGroupsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchUserHierarchyGroupsRequest

public static interface SearchUserHierarchyGroupsRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchUserHierarchyGroupsRequest.Builder,SearchUserHierarchyGroupsRequest>

Method Summary

Modifier and Type	Method	Description
SearchUserHierarchyGroupsRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchUserHierarchyGroupsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchUserHierarchyGroupsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchUserHierarchyGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchUserHierarchyGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchUserHierarchyGroupsRequest.Builder	searchCriteria(Consumer<UserHierarchyGroupSearchCriteria.Builder> searchCriteria)	The search criteria to be used to return UserHierarchyGroups.
SearchUserHierarchyGroupsRequest.Builder	searchCriteria(UserHierarchyGroupSearchCriteria searchCriteria)	The search criteria to be used to return UserHierarchyGroups.
default SearchUserHierarchyGroupsRequest.Builder	searchFilter(Consumer<UserHierarchyGroupSearchFilter.Builder> searchFilter)	Filters to be applied to search results.
SearchUserHierarchyGroupsRequest.Builder	searchFilter(UserHierarchyGroupSearchFilter searchFilter)	Filters to be applied to search results.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

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 Details

instanceId

SearchUserHierarchyGroupsRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

SearchUserHierarchyGroupsRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

SearchUserHierarchyGroupsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchFilter

SearchUserHierarchyGroupsRequest.Builder searchFilter(UserHierarchyGroupSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchFilter

default SearchUserHierarchyGroupsRequest.Builder searchFilter(Consumer<UserHierarchyGroupSearchFilter.Builder> searchFilter)

Filters to be applied to search results.

This is a convenience method that creates an instance of the UserHierarchyGroupSearchFilter.Builder avoiding the need to create one manually via UserHierarchyGroupSearchFilter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchFilter(UserHierarchyGroupSearchFilter).

Parameters:

searchFilter - a consumer that will call methods on UserHierarchyGroupSearchFilter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• searchFilter(UserHierarchyGroupSearchFilter)

searchCriteria

SearchUserHierarchyGroupsRequest.Builder searchCriteria(UserHierarchyGroupSearchCriteria searchCriteria)

The search criteria to be used to return UserHierarchyGroups.

Parameters:

searchCriteria - The search criteria to be used to return UserHierarchyGroups.

Returns:

Returns a reference to this object so that method calls can be chained together.

searchCriteria

default SearchUserHierarchyGroupsRequest.Builder searchCriteria(Consumer<UserHierarchyGroupSearchCriteria.Builder> searchCriteria)

The search criteria to be used to return UserHierarchyGroups.

This is a convenience method that creates an instance of the UserHierarchyGroupSearchCriteria.Builder avoiding the need to create one manually via UserHierarchyGroupSearchCriteria.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchCriteria(UserHierarchyGroupSearchCriteria).

Parameters:

searchCriteria - a consumer that will call methods on UserHierarchyGroupSearchCriteria.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• searchCriteria(UserHierarchyGroupSearchCriteria)

overrideConfiguration

SearchUserHierarchyGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SearchUserHierarchyGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.