Interface ListDevicePositionsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListDevicePositionsRequest.Builder,ListDevicePositionsRequest>, LocationRequest.Builder, SdkBuilder<ListDevicePositionsRequest.Builder,ListDevicePositionsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListDevicePositionsRequest

@Mutable
@NotThreadSafe
public static interface ListDevicePositionsRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ListDevicePositionsRequest.Builder,ListDevicePositionsRequest>

Method Summary

Modifier and Type	Method	Description
default ListDevicePositionsRequest.Builder	filterGeometry(Consumer<TrackingFilterGeometry.Builder> filterGeometry)	The geometry used to filter device positions.
ListDevicePositionsRequest.Builder	filterGeometry(TrackingFilterGeometry filterGeometry)	The geometry used to filter device positions.
ListDevicePositionsRequest.Builder	maxResults(Integer maxResults)	An optional limit for the number of entries returned in a single call.
ListDevicePositionsRequest.Builder	nextToken(String nextToken)	The pagination token specifying which page of results to return in the response.
ListDevicePositionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListDevicePositionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListDevicePositionsRequest.Builder	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, sdkFieldNameToField, sdkFields

Method Details

trackerName

ListDevicePositionsRequest.Builder trackerName(String 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.

maxResults

ListDevicePositionsRequest.Builder maxResults(Integer 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

ListDevicePositionsRequest.Builder nextToken(String 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.

filterGeometry

ListDevicePositionsRequest.Builder filterGeometry(TrackingFilterGeometry 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 the TrackingFilterGeometry.Builder avoiding the need to create one manually via TrackingFilterGeometry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filterGeometry(TrackingFilterGeometry).

Parameters:

filterGeometry - a consumer that will call methods on TrackingFilterGeometry.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• filterGeometry(TrackingFilterGeometry)

overrideConfiguration

ListDevicePositionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.