Interface ListDevicePositionsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListDevicePositionsRequest.Builder,
,ListDevicePositionsRequest> LocationRequest.Builder
,SdkBuilder<ListDevicePositionsRequest.Builder,
,ListDevicePositionsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ListDevicePositionsRequest
public static interface ListDevicePositionsRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ListDevicePositionsRequest.Builder,ListDevicePositionsRequest>
-
Method Summary
Modifier and TypeMethodDescriptionfilterGeometry
(Consumer<TrackingFilterGeometry.Builder> filterGeometry) The geometry used to filter device positions.filterGeometry
(TrackingFilterGeometry filterGeometry) The geometry used to filter device positions.maxResults
(Integer maxResults) An optional limit for the number of entries returned in a single call.The pagination token specifying which page of results to return in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.trackerName
(String trackerName) The tracker resource containing the requested devices.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.location.model.LocationRequest.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
-
filterGeometry
The geometry used to filter device positions.
- Parameters:
filterGeometry
- The geometry used to filter device positions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filterGeometry
default ListDevicePositionsRequest.Builder filterGeometry(Consumer<TrackingFilterGeometry.Builder> filterGeometry) The geometry used to filter device positions.
This is a convenience method that creates an instance of theTrackingFilterGeometry.Builder
avoiding the need to create one manually viaTrackingFilterGeometry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilterGeometry(TrackingFilterGeometry)
.- Parameters:
filterGeometry
- a consumer that will call methods onTrackingFilterGeometry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
An optional limit for the number of entries returned in a single call.
Default value:
100
- Parameters:
maxResults
- An optional limit for the number of entries returned in a single call.Default value:
100
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.
Default value:
null
- Parameters:
nextToken
- The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.Default value:
null
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trackerName
The tracker resource containing the requested devices.
- Parameters:
trackerName
- The tracker resource containing the requested devices.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListDevicePositionsRequest.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
ListDevicePositionsRequest.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.
-