Package software.amazon.awssdk.services.location.model

Interface DevicePositionUpdate.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DevicePositionUpdate.Builder,DevicePositionUpdate>, SdkBuilder<DevicePositionUpdate.Builder,DevicePositionUpdate>, SdkPojo

Enclosing class:

DevicePositionUpdate

public static interface DevicePositionUpdate.Builder
extends SdkPojo, CopyableBuilder<DevicePositionUpdate.Builder,DevicePositionUpdate>

Method Summary

Modifier and Type	Method	Description
default DevicePositionUpdate.Builder	accuracy(Consumer<PositionalAccuracy.Builder> accuracy)	The accuracy of the device position.
DevicePositionUpdate.Builder	accuracy(PositionalAccuracy accuracy)	The accuracy of the device position.
DevicePositionUpdate.Builder	deviceId(String deviceId)	The device associated to the position update.
DevicePositionUpdate.Builder	position(Double... position)	The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
DevicePositionUpdate.Builder	position(Collection<Double> position)	The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].
DevicePositionUpdate.Builder	positionProperties(Map<String,String> positionProperties)	Associates one of more properties with the position update.
DevicePositionUpdate.Builder	sampleTime(Instant sampleTime)	The timestamp at which the device's position was determined.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

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

accuracy

DevicePositionUpdate.Builder accuracy(PositionalAccuracy accuracy)

The accuracy of the device position.

Parameters:

accuracy - The accuracy of the device position.

Returns:

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

accuracy

default DevicePositionUpdate.Builder accuracy(Consumer<PositionalAccuracy.Builder> accuracy)

The accuracy of the device position.

This is a convenience method that creates an instance of the PositionalAccuracy.Builder avoiding the need to create one manually via PositionalAccuracy.builder().

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

Parameters:

accuracy - a consumer that will call methods on PositionalAccuracy.Builder

Returns:

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

See Also:

accuracy(PositionalAccuracy)

deviceId

DevicePositionUpdate.Builder deviceId(String deviceId)

The device associated to the position update.

Parameters:

deviceId - The device associated to the position update.

Returns:

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

position

DevicePositionUpdate.Builder position(Collection<Double> position)

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

Parameters:

position - The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

Returns:

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

position

DevicePositionUpdate.Builder position(Double... position)

The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

Parameters:

position - The latest device position defined in WGS 84 format: [X or longitude, Y or latitude].

Returns:

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

positionProperties

DevicePositionUpdate.Builder positionProperties(Map<String,String> positionProperties)

Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

Format: "key" : "value"

Parameters:

positionProperties - Associates one of more properties with the position update. A property is a key-value pair stored with the position update and added to any geofence event the update may trigger.

Format: "key" : "value"

Returns:

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

sampleTime

DevicePositionUpdate.Builder sampleTime(Instant sampleTime)

The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Parameters:

sampleTime - The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

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