Interface SearchGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>, QuickSightRequest.Builder, SdkBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchGroupsRequest

public static interface SearchGroupsRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<SearchGroupsRequest.Builder,SearchGroupsRequest>

Method Summary

Modifier and Type	Method	Description
SearchGroupsRequest.Builder	awsAccountId(String awsAccountId)	The ID for the Amazon Web Services account that the group is in.
SearchGroupsRequest.Builder	filters(Collection<GroupSearchFilter> filters)	The structure for the search filters that you want to apply to your search.
SearchGroupsRequest.Builder	filters(Consumer<GroupSearchFilter.Builder>... filters)	The structure for the search filters that you want to apply to your search.
SearchGroupsRequest.Builder	filters(GroupSearchFilter... filters)	The structure for the search filters that you want to apply to your search.
SearchGroupsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return from this request.
SearchGroupsRequest.Builder	namespace(String namespace)	The namespace that you want to search.
SearchGroupsRequest.Builder	nextToken(String nextToken)	A pagination token that can be used in a subsequent request.
SearchGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.quicksight.model.QuickSightRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

awsAccountId

SearchGroupsRequest.Builder awsAccountId(String awsAccountId)

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Parameters:

awsAccountId - The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Returns:

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

nextToken

SearchGroupsRequest.Builder nextToken(String nextToken)

A pagination token that can be used in a subsequent request.

Parameters:

nextToken - A pagination token that can be used in a subsequent request.

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 return from this request.

Parameters:

maxResults - The maximum number of results to return from this request.

Returns:

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

namespace

SearchGroupsRequest.Builder namespace(String namespace)

The namespace that you want to search.

Parameters:

namespace - The namespace that you want to search.

Returns:

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

filters

SearchGroupsRequest.Builder filters(Collection<GroupSearchFilter> filters)

The structure for the search filters that you want to apply to your search.

Parameters:

filters - The structure for the search filters that you want to apply to your search.

Returns:

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

filters

SearchGroupsRequest.Builder filters(GroupSearchFilter... filters)

The structure for the search filters that you want to apply to your search.

Parameters:

filters - The structure for the search filters that you want to apply to your search.

Returns:

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

filters

SearchGroupsRequest.Builder filters(Consumer<GroupSearchFilter.Builder>... filters)

The structure for the search filters that you want to apply to your search.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<GroupSearchFilter>).

Parameters:

filters - a consumer that will call methods on GroupSearchFilter.Builder

Returns:

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

See Also:

• filters(java.util.Collection<GroupSearchFilter>)

overrideConfiguration

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

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