Interface ListTasksRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListTasksRequest.Builder,,ListTasksRequest> DataSyncRequest.Builder,SdkBuilder<ListTasksRequest.Builder,,ListTasksRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListTasksRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters(Collection<TaskFilter> filters) You can use API filters to narrow down the list of resources returned byListTasks.filters(Consumer<TaskFilter.Builder>... filters) You can use API filters to narrow down the list of resources returned byListTasks.filters(TaskFilter... filters) You can use API filters to narrow down the list of resources returned byListTasks.maxResults(Integer maxResults) The maximum number of tasks to return.An opaque string that indicates the position at which to begin the next list of tasks.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
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.datasync.model.DataSyncRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
maxResults
The maximum number of tasks to return.
- Parameters:
maxResults- The maximum number of tasks to return.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
An opaque string that indicates the position at which to begin the next list of tasks.
- Parameters:
nextToken- An opaque string that indicates the position at which to begin the next list of tasks.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
You can use API filters to narrow down the list of resources returned by
ListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.- Parameters:
filters- You can use API filters to narrow down the list of resources returned byListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
You can use API filters to narrow down the list of resources returned by
ListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.- Parameters:
filters- You can use API filters to narrow down the list of resources returned byListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
You can use API filters to narrow down the list of resources returned by
This is a convenience method that creates an instance of theListTasks. For example, to retrieve all tasks on a specific source location, you can useListTaskswith filter nameLocationIdandOperator Equalswith the ARN for the location.TaskFilter.Builderavoiding the need to create one manually viaTaskFilter.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofilters(List<TaskFilter>).- Parameters:
filters- a consumer that will call methods onTaskFilter.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListTasksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListTasksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-