Interface ListUsersIndexCapacityRequest.Builder

All Superinterfaces:

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

Enclosing class:

ListUsersIndexCapacityRequest

@Mutable
@NotThreadSafe
public static interface ListUsersIndexCapacityRequest.Builder
extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<ListUsersIndexCapacityRequest.Builder,ListUsersIndexCapacityRequest>

Method Summary

Modifier and Type	Method	Description
ListUsersIndexCapacityRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that contains the index capacity data.
ListUsersIndexCapacityRequest.Builder	filters(Collection<UserIndexCapacityFilter> filters)	Filters to apply.
ListUsersIndexCapacityRequest.Builder	filters(Consumer<UserIndexCapacityFilter.Builder>... filters)	Filters to apply.
ListUsersIndexCapacityRequest.Builder	filters(UserIndexCapacityFilter... filters)	Filters to apply.
ListUsersIndexCapacityRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
ListUsersIndexCapacityRequest.Builder	namespace(String namespace)	The namespace to scope the user search to.
ListUsersIndexCapacityRequest.Builder	nextToken(String nextToken)	The token for the next set of results, received from a previous call.
ListUsersIndexCapacityRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListUsersIndexCapacityRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListUsersIndexCapacityRequest.Builder	sortBy(String sortBy)	The field to sort results by.
ListUsersIndexCapacityRequest.Builder	sortBy(UserIndexCapacitySortBy sortBy)	The field to sort results by.
ListUsersIndexCapacityRequest.Builder	sortOrder(String sortOrder)	The sort order for results.
ListUsersIndexCapacityRequest.Builder	sortOrder(UserIndexCapacitySortOrder sortOrder)	The sort order for results.

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, sdkFieldNameToField, sdkFields

Method Details

awsAccountId

ListUsersIndexCapacityRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the index capacity data.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the index capacity data.

Returns:

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

namespace

ListUsersIndexCapacityRequest.Builder namespace(String namespace)

The namespace to scope the user search to. Required when the userNameOrEmail filter is present.

Parameters:

namespace - The namespace to scope the user search to. Required when the userNameOrEmail filter is present.

Returns:

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

filters

ListUsersIndexCapacityRequest.Builder filters(Collection<UserIndexCapacityFilter> filters)

Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

Parameters:

filters - Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

Returns:

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

filters

ListUsersIndexCapacityRequest.Builder filters(UserIndexCapacityFilter... filters)

Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

Parameters:

filters - Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

Returns:

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

filters

ListUsersIndexCapacityRequest.Builder filters(Consumer<UserIndexCapacityFilter.Builder>... filters)

Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.

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

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

Parameters:

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

Returns:

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

See Also:

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

sortBy

ListUsersIndexCapacityRequest.Builder sortBy(String sortBy)

The field to sort results by.

Parameters:

sortBy - The field to sort results by.

Returns:

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

See Also:

• UserIndexCapacitySortBy
• UserIndexCapacitySortBy

sortBy

ListUsersIndexCapacityRequest.Builder sortBy(UserIndexCapacitySortBy sortBy)

The field to sort results by.

Parameters:

sortBy - The field to sort results by.

Returns:

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

See Also:

• UserIndexCapacitySortBy
• UserIndexCapacitySortBy

sortOrder

ListUsersIndexCapacityRequest.Builder sortOrder(String sortOrder)

The sort order for results. Defaults to DESC if not specified.

Parameters:

sortOrder - The sort order for results. Defaults to DESC if not specified.

Returns:

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

See Also:

• UserIndexCapacitySortOrder
• UserIndexCapacitySortOrder

sortOrder

ListUsersIndexCapacityRequest.Builder sortOrder(UserIndexCapacitySortOrder sortOrder)

The sort order for results. Defaults to DESC if not specified.

Parameters:

sortOrder - The sort order for results. Defaults to DESC if not specified.

Returns:

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

See Also:

• UserIndexCapacitySortOrder
• UserIndexCapacitySortOrder

maxResults

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

nextToken

ListUsersIndexCapacityRequest.Builder nextToken(String nextToken)

The token for the next set of results, received from a previous call.

Parameters:

nextToken - The token for the next set of results, received from a previous call.

Returns:

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

overrideConfiguration

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

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