Interface ListLocationsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListLocationsRequest.Builder,
,ListLocationsRequest> DataSyncRequest.Builder
,SdkBuilder<ListLocationsRequest.Builder,
,ListLocationsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListLocationsRequest
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<LocationFilter> filters) You can use API filters to narrow down the list of resources returned byListLocations
.filters
(Consumer<LocationFilter.Builder>... filters) You can use API filters to narrow down the list of resources returned byListLocations
.filters
(LocationFilter... filters) You can use API filters to narrow down the list of resources returned byListLocations
.maxResults
(Integer maxResults) The maximum number of locations to return.An opaque string that indicates the position at which to begin the next list of locations.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.datasync.model.DataSyncRequest.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
-
maxResults
The maximum number of locations to return.
- Parameters:
maxResults
- The maximum number of locations 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 locations.
- Parameters:
nextToken
- An opaque string that indicates the position at which to begin the next list of locations.- 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
ListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
.- Parameters:
filters
- You can use API filters to narrow down the list of resources returned byListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
.- 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
ListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
.- Parameters:
filters
- You can use API filters to narrow down the list of resources returned byListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
.- 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 theListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
.LocationFilter.Builder
avoiding the need to create one manually viaLocationFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<LocationFilter>)
.- Parameters:
filters
- a consumer that will call methods onLocationFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
ListLocationsRequest.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
ListLocationsRequest.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.
-