Interface SearchDashboardsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchDashboardsRequest.Builder,
,SearchDashboardsRequest> QuickSightRequest.Builder
,SdkBuilder<SearchDashboardsRequest.Builder,
,SearchDashboardsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
SearchDashboardsRequest
-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId
(String awsAccountId) The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.filters
(Collection<DashboardSearchFilter> filters) The filters to apply to the search.filters
(Consumer<DashboardSearchFilter.Builder>... filters) The filters to apply to the search.filters
(DashboardSearchFilter... filters) The filters to apply to the search.maxResults
(Integer maxResults) The maximum number of results to be returned per request.The token for the next set of results, or null if there are no more results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.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
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
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
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
The filters to apply to the search. Currently, you can search only by user name, for example,
This is a convenience method that creates an instance of the"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
DashboardSearchFilter.Builder
avoiding the need to create one manually viaDashboardSearchFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<DashboardSearchFilter>)
.- Parameters:
filters
- a consumer that will call methods onDashboardSearchFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
SearchDashboardsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-