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

Class UpdateTrackerRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.UpdateTrackerRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateTrackerRequest
extends LocationRequest
implements ToCopyableBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateTrackerRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateTrackerRequest.Builder	builder()
String	description()	Updates the description for the tracker resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	eventBridgeEnabled()	Whether to enable position UPDATE events from this tracker to be sent to EventBridge.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	kmsKeyEnableGeospatialQueries()	Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
PositionFiltering	positionFiltering()	Updates the position filtering for the tracker resource.
String	positionFilteringAsString()	Updates the position filtering for the tracker resource.
PricingPlan	pricingPlan()	Deprecated. Deprecated.
String	pricingPlanAsString()	Deprecated. Deprecated.
String	pricingPlanDataSource()	Deprecated. Deprecated.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateTrackerRequest.Builder>	serializableBuilderClass()
UpdateTrackerRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trackerName()	The name of the tracker resource to update.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

description

public final String description()

Updates the description for the tracker resource.

Returns:

Updates the description for the tracker resource.

eventBridgeEnabled

public final Boolean eventBridgeEnabled()

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

Returns:

Whether to enable position UPDATE events from this tracker to be sent to EventBridge.

You do not need enable this feature to get ENTER and EXIT events for geofences with this tracker. Those events are always sent to EventBridge.

kmsKeyEnableGeospatialQueries

public final Boolean kmsKeyEnableGeospatialQueries()

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

Returns:

Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.

This parameter is only used if you are using a KMS customer managed key.

positionFiltering

public final PositionFiltering positionFiltering()

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

If the service returns an enum value that is not available in the current SDK version, positionFiltering will return PositionFiltering.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionFilteringAsString().

Returns:

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

See Also:

PositionFiltering

positionFilteringAsString

public final String positionFilteringAsString()

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

If the service returns an enum value that is not available in the current SDK version, positionFiltering will return PositionFiltering.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionFilteringAsString().

Returns:

Updates the position filtering for the tracker resource.

Valid values:

• TimeBased - Location updates are evaluated against linked geofence collections, but not every location update is stored. If your update frequency is more often than 30 seconds, only one update per 30 seconds is stored for each unique device ID.

• DistanceBased - If the device has moved less than 30 m (98.4 ft), location updates are ignored. Location updates within this distance are neither evaluated against linked geofence collections, nor stored. This helps control costs by reducing the number of geofence evaluations and historical device positions to paginate through. Distance-based filtering can also reduce the effects of GPS noise when displaying device trajectories on a map.

• AccuracyBased - If the device has moved less than the measured accuracy, location updates are ignored. For example, if two consecutive updates from a device have a horizontal accuracy of 5 m and 10 m, the second update is ignored if the device has moved less than 15 m. Ignored location updates are neither evaluated against linked geofence collections, nor stored. This helps educe the effects of GPS noise when displaying device trajectories on a map, and can help control costs by reducing the number of geofence evaluations.

See Also:

PositionFiltering

pricingPlan

@Deprecated
public final PricingPlan pricingPlan()

Deprecated.

Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

Returns:

No longer used. If included, the only allowed value is RequestBasedUsage.

See Also:

PricingPlan

pricingPlanAsString

@Deprecated
public final String pricingPlanAsString()

Deprecated.

Deprecated. If included, the only allowed value is RequestBasedUsage.

No longer used. If included, the only allowed value is RequestBasedUsage.

If the service returns an enum value that is not available in the current SDK version, pricingPlan will return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

Returns:

No longer used. If included, the only allowed value is RequestBasedUsage.

See Also:

PricingPlan

pricingPlanDataSource

@Deprecated
public final String pricingPlanDataSource()

Deprecated.

Deprecated. No longer allowed.

This parameter is no longer used.

Returns:

This parameter is no longer used.

trackerName

public final String trackerName()

The name of the tracker resource to update.

Returns:

The name of the tracker resource to update.

toBuilder

public UpdateTrackerRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static UpdateTrackerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateTrackerRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo