/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.location.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateTrackerRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* An optional description for the tracker resource. *
*/ private String description; /** *
* 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.
*
* A key identifier for an Amazon * Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. *
*/ private String kmsKeyId; /** ** Specifies 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 area 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 can reduce the effects of GPS noise when displaying device
* trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
* This parameter is no longer used. *
*/ @Deprecated private String pricingPlanDataSource; /** ** Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and * filter your resources by labelling them. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
** The name for the tracker resource. *
** Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* An optional description for the tracker resource. *
* * @param description * An optional description for the tracker resource. */ public void setDescription(String description) { this.description = description; } /** ** An optional description for the tracker resource. *
* * @return An optional description for the tracker resource. */ public String getDescription() { return this.description; } /** ** An optional description for the tracker resource. *
* * @param description * An optional description for the tracker resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateTrackerRequest withDescription(String description) { setDescription(description); return this; } /** *
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*
* 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.
*
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.
*
* A key identifier for an Amazon * Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. *
* * @param kmsKeyId * A key identifier for an Amazon Web Services KMS * customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** ** A key identifier for an Amazon * Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. *
* * @return A key identifier for an Amazon Web Services KMS * customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. */ public String getKmsKeyId() { return this.kmsKeyId; } /** ** A key identifier for an Amazon * Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. *
* * @param kmsKeyId * A key identifier for an Amazon Web Services KMS * customer managed key. Enter a key ID, key ARN, alias name, or alias ARN. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateTrackerRequest withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); return this; } /** ** Specifies 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 area 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 can reduce the effects of GPS noise when displaying device
* trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
*
* 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 area 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 can reduce the effects of GPS noise when
* displaying device trajectories on a map, and can help control your costs by reducing the number of
* geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
* @see PositionFiltering
*/
public void setPositionFiltering(String positionFiltering) {
this.positionFiltering = positionFiltering;
}
/**
*
* Specifies 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 area 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 can reduce the effects of GPS noise when displaying device
* trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
*
* 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 area 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 can reduce the effects of GPS
* noise when displaying device trajectories on a map, and can help control your costs by reducing the
* number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
* @see PositionFiltering
*/
public String getPositionFiltering() {
return this.positionFiltering;
}
/**
*
* Specifies 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 area 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 can reduce the effects of GPS noise when displaying device
* trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
*
* 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 area 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 can reduce the effects of GPS noise when
* displaying device trajectories on a map, and can help control your costs by reducing the number of
* geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PositionFiltering
*/
public CreateTrackerRequest withPositionFiltering(String positionFiltering) {
setPositionFiltering(positionFiltering);
return this;
}
/**
*
* Specifies 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 area 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 can reduce the effects of GPS noise when displaying device
* trajectories on a map, and can help control your costs by reducing the number of geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
*
* 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 area 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 can reduce the effects of GPS noise when
* displaying device trajectories on a map, and can help control your costs by reducing the number of
* geofence evaluations.
*
* This field is optional. If not specified, the default value is TimeBased
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PositionFiltering
*/
public CreateTrackerRequest withPositionFiltering(PositionFiltering positionFiltering) {
this.positionFiltering = positionFiltering.toString();
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateTrackerRequest withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateTrackerRequest withPricingPlan(PricingPlan pricingPlan) {
this.pricingPlan = pricingPlan.toString();
return this;
}
/**
* * This parameter is no longer used. *
* * @param pricingPlanDataSource * This parameter is no longer used. */ @Deprecated public void setPricingPlanDataSource(String pricingPlanDataSource) { this.pricingPlanDataSource = pricingPlanDataSource; } /** ** This parameter is no longer used. *
* * @return This parameter is no longer used. */ @Deprecated public String getPricingPlanDataSource() { return this.pricingPlanDataSource; } /** ** This parameter is no longer used. *
* * @param pricingPlanDataSource * This parameter is no longer used. * @return Returns a reference to this object so that method calls can be chained together. */ @Deprecated public CreateTrackerRequest withPricingPlanDataSource(String pricingPlanDataSource) { setPricingPlanDataSource(pricingPlanDataSource); return this; } /** ** Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and * filter your resources by labelling them. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
** Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and * filter your resources by labelling them. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
** Applies one or more tags to the tracker resource. A tag is a key-value pair helps manage, identify, search, and * filter your resources by labelling them. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
*
* Format: "key" : "value"
*
* Restrictions: *
** Maximum 50 tags per resource *
** Each resource tag must be unique with a maximum of one value. *
** Maximum key length: 128 Unicode characters in UTF-8 *
** Maximum value length: 256 Unicode characters in UTF-8 *
** Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @. *
** Cannot use "aws:" as a prefix for a key. *
** The name for the tracker resource. *
** Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* The name for the tracker resource. *
** Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* The name for the tracker resource. *
** Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*
* Requirements: *
** Contain only alphanumeric characters (A-Z, a-z, 0-9) , hyphens (-), periods (.), and underscores (_). *
** Must be a unique tracker resource name. *
*
* No spaces allowed. For example, ExampleTracker
.
*