com.amazonaws.services.location.model

Class CreateTrackerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.CreateTrackerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTrackerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateTrackerRequest()

Method Summary

Modifier and Type	Method and Description
CreateTrackerRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateTrackerRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateTrackerRequest	clone()
boolean	equals(Object obj)
String	getDescription() An optional description for the tracker resource.
String	getKmsKeyId() A key identifier for an AWS KMS customer managed key.
String	getPositionFiltering() Specifies the position filtering for the tracker resource.
String	getPricingPlan() Specifies the pricing plan for the tracker resource.
String	getPricingPlanDataSource() Specifies the data provider for the tracker resource.
Map<String,String>	getTags() Applies one or more tags to the tracker resource.
String	getTrackerName() The name for the tracker resource.
int	hashCode()
void	setDescription(String description) An optional description for the tracker resource.
void	setKmsKeyId(String kmsKeyId) A key identifier for an AWS KMS customer managed key.
void	setPositionFiltering(String positionFiltering) Specifies the position filtering for the tracker resource.
void	setPricingPlan(String pricingPlan) Specifies the pricing plan for the tracker resource.
void	setPricingPlanDataSource(String pricingPlanDataSource) Specifies the data provider for the tracker resource.
void	setTags(Map<String,String> tags) Applies one or more tags to the tracker resource.
void	setTrackerName(String trackerName) The name for the tracker resource.
String	toString() Returns a string representation of this object.
CreateTrackerRequest	withDescription(String description) An optional description for the tracker resource.
CreateTrackerRequest	withKmsKeyId(String kmsKeyId) A key identifier for an AWS KMS customer managed key.
CreateTrackerRequest	withPositionFiltering(PositionFiltering positionFiltering) Specifies the position filtering for the tracker resource.
CreateTrackerRequest	withPositionFiltering(String positionFiltering) Specifies the position filtering for the tracker resource.
CreateTrackerRequest	withPricingPlan(PricingPlan pricingPlan) Specifies the pricing plan for the tracker resource.
CreateTrackerRequest	withPricingPlan(String pricingPlan) Specifies the pricing plan for the tracker resource.
CreateTrackerRequest	withPricingPlanDataSource(String pricingPlanDataSource) Specifies the data provider for the tracker resource.
CreateTrackerRequest	withTags(Map<String,String> tags) Applies one or more tags to the tracker resource.
CreateTrackerRequest	withTrackerName(String trackerName) The name for the tracker resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateTrackerRequest

public CreateTrackerRequest()

Method Detail

setDescription

public void setDescription(String description)

An optional description for the tracker resource.

Parameters:

description - An optional description for the tracker resource.

getDescription

public String getDescription()

An optional description for the tracker resource.

Returns:

An optional description for the tracker resource.

withDescription

public CreateTrackerRequest withDescription(String description)

An optional description for the tracker resource.

Parameters:

description - An optional description for the tracker resource.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Parameters:

kmsKeyId - A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

getKmsKeyId

public String getKmsKeyId()

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

withKmsKeyId

public CreateTrackerRequest withKmsKeyId(String kmsKeyId)

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Parameters:

kmsKeyId - A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

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

setPositionFiltering

public void setPositionFiltering(String 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.

This field is optional. If not specified, the default value is TimeBased.

Parameters:

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.

This field is optional. If not specified, the default value is TimeBased.

See Also:

PositionFiltering

getPositionFiltering

public String getPositionFiltering()

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.

This field is optional. If not specified, the default value is TimeBased.

Returns:

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.

This field is optional. If not specified, the default value is TimeBased.

See Also:

PositionFiltering

withPositionFiltering

public CreateTrackerRequest withPositionFiltering(String 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.

This field is optional. If not specified, the default value is TimeBased.

Parameters:

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.

This field is optional. If not specified, the default value is TimeBased.

Returns:

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

See Also:

PositionFiltering

withPositionFiltering

public CreateTrackerRequest withPositionFiltering(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.

This field is optional. If not specified, the default value is TimeBased.

Parameters:

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.

This field is optional. If not specified, the default value is TimeBased.

Returns:

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

See Also:

PositionFiltering

setPricingPlan

public void setPricingPlan(String pricingPlan)

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Parameters:

pricingPlan - Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

See Also:

PricingPlan

getPricingPlan

public String getPricingPlan()

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Returns:

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

See Also:

PricingPlan

withPricingPlan

public CreateTrackerRequest withPricingPlan(String pricingPlan)

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Parameters:

pricingPlan - Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Returns:

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

See Also:

PricingPlan

withPricingPlan

public CreateTrackerRequest withPricingPlan(PricingPlan pricingPlan)

Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Parameters:

pricingPlan - Specifies the pricing plan for the tracker resource.

For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.

Returns:

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

See Also:

PricingPlan

setPricingPlanDataSource

public void setPricingPlanDataSource(String pricingPlanDataSource)

Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

Parameters:

pricingPlanDataSource - Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

getPricingPlanDataSource

public String getPricingPlanDataSource()

Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

Returns:

Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

withPricingPlanDataSource

public CreateTrackerRequest withPricingPlanDataSource(String pricingPlanDataSource)

Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

Parameters:

pricingPlanDataSource - Specifies the data provider for the tracker resource.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your tracker resource. Your data will not be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid values: Esri | Here

Returns:

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

getTags

public Map<String,String> getTags()

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.

Returns:

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.

setTags

public void setTags(Map<String,String> tags)

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.

Parameters:

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

withTags

public CreateTrackerRequest withTags(Map<String,String> tags)

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.

Parameters:

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

Returns:

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

addTagsEntry

public CreateTrackerRequest addTagsEntry(String key,
                                         String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateTrackerRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setTrackerName

public void setTrackerName(String trackerName)

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.

Parameters:

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

getTrackerName

public String getTrackerName()

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.

Returns:

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.

withTrackerName

public CreateTrackerRequest withTrackerName(String trackerName)

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.

Parameters:

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

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateTrackerRequest clone()

Overrides:

clone in class AmazonWebServiceRequest