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

Interface UpdateTrackerRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>, LocationRequest.Builder, SdkBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateTrackerRequest
public static interface UpdateTrackerRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<UpdateTrackerRequest.Builder,UpdateTrackerRequest>

  • Method Details

    • description

      UpdateTrackerRequest.Builder description(String description)

      Updates the description for the tracker resource.

      Parameters:
      description - Updates the description for the tracker resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventBridgeEnabled

      UpdateTrackerRequest.Builder eventBridgeEnabled(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyEnableGeospatialQueries

      UpdateTrackerRequest.Builder kmsKeyEnableGeospatialQueries(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • positionFiltering

      UpdateTrackerRequest.Builder positionFiltering(String 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.

      Parameters:
      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.

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

    • positionFiltering

      UpdateTrackerRequest.Builder positionFiltering(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.

      Parameters:
      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.

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

    • pricingPlan

      @Deprecated UpdateTrackerRequest.Builder pricingPlan(String pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

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

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pricingPlan

      @Deprecated UpdateTrackerRequest.Builder pricingPlan(PricingPlan pricingPlan)
      Deprecated.
      Deprecated. If included, the only allowed value is RequestBasedUsage.

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

      Parameters:
      pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pricingPlanDataSource

      @Deprecated UpdateTrackerRequest.Builder pricingPlanDataSource(String pricingPlanDataSource)
      Deprecated.
      Deprecated. No longer allowed.

      This parameter is no longer used.

      Parameters:
      pricingPlanDataSource - This parameter is no longer used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trackerName

      UpdateTrackerRequest.Builder trackerName(String trackerName)

      The name of the tracker resource to update.

      Parameters:
      trackerName - The name of the tracker resource to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateTrackerRequest.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

      UpdateTrackerRequest.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.