Interface SearchFoldersRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<SearchFoldersRequest.Builder,SearchFoldersRequest>
,QuickSightRequest.Builder
,SdkBuilder<SearchFoldersRequest.Builder,SearchFoldersRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- SearchFoldersRequest
public static interface SearchFoldersRequest.Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder<SearchFoldersRequest.Builder,SearchFoldersRequest>
-
-
Method Summary
-
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
SearchFoldersRequest.Builder awsAccountId(String awsAccountId)
The ID for the Amazon Web Services account that contains the folder.
- Parameters:
awsAccountId
- The ID for the Amazon Web Services account that contains the folder.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
SearchFoldersRequest.Builder filters(Collection<FolderSearchFilter> filters)
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.- Parameters:
filters
- The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
SearchFoldersRequest.Builder filters(FolderSearchFilter... filters)
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.- Parameters:
filters
- The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
SearchFoldersRequest.Builder filters(Consumer<FolderSearchFilter.Builder>... filters)
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
This is a convenience method that creates an instance of the"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]
.FolderSearchFilter.Builder
avoiding the need to create one manually viaFolderSearchFilter.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 onFolderSearchFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
nextToken
SearchFoldersRequest.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
SearchFoldersRequest.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
SearchFoldersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
SearchFoldersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-