Package software.amazon.awssdk.services.quicksight.model

Interface SearchDashboardsRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchDashboardsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchDashboardsRequest.Builder	awsAccountId(String awsAccountId)	The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
SearchDashboardsRequest.Builder	filters(Collection<DashboardSearchFilter> filters)	The filters to apply to the search.
SearchDashboardsRequest.Builder	filters(Consumer<DashboardSearchFilter.Builder>... filters)	The filters to apply to the search.
SearchDashboardsRequest.Builder	filters(DashboardSearchFilter... filters)	The filters to apply to the search.
SearchDashboardsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to be returned per request.
SearchDashboardsRequest.Builder	nextToken(String nextToken)	The token for the next set of results, or null if there are no more results.
SearchDashboardsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SearchDashboardsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

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 Detail

awsAccountId

SearchDashboardsRequest.Builder awsAccountId(String awsAccountId)

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Parameters:

awsAccountId - The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.

Returns:

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

filters

SearchDashboardsRequest.Builder filters(Collection<DashboardSearchFilter> filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Parameters:

filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Returns:

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

filters

SearchDashboardsRequest.Builder filters(DashboardSearchFilter... filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Parameters:

filters - The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

Returns:

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

filters

SearchDashboardsRequest.Builder filters(Consumer<DashboardSearchFilter.Builder>... filters)

The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]

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

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

Parameters:

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

Returns:

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

See Also:

#filters(java.util.Collection)

nextToken

SearchDashboardsRequest.Builder nextToken(String nextToken)

The token for the next set of results, or null if there are no more results.

Parameters:

nextToken - The token for the next set of results, or null if there are no more results.

Returns:

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

maxResults

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

overrideConfiguration

SearchDashboardsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder