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

Class DescribeTrackerResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.DescribeTrackerResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTrackerResponse.Builder,DescribeTrackerResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTrackerResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTrackerResponse.Builder	builder()
Instant	createTime()	The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
String	description()	The optional description for the tracker resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	eventBridgeEnabled()	Whether UPDATE events from this tracker in EventBridge are enabled.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Boolean	kmsKeyEnableGeospatialQueries()	Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
String	kmsKeyId()	A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
PositionFiltering	positionFiltering()	The position filtering method of the tracker resource.
String	positionFilteringAsString()	The position filtering method of the tracker resource.
PricingPlan	pricingPlan()	Deprecated. Deprecated.
String	pricingPlanAsString()	Deprecated. Deprecated.
String	pricingPlanDataSource()	Deprecated. Deprecated.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTrackerResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags associated with the tracker resource.
DescribeTrackerResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trackerArn()	The Amazon Resource Name (ARN) for the tracker resource.
String	trackerName()	The name of the tracker resource.
Instant	updateTime()	The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

createTime

public final Instant createTime()

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

description

public final String description()

The optional description for the tracker resource.

Returns:

The optional description for the tracker resource.

eventBridgeEnabled

public final Boolean eventBridgeEnabled()

Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be sent to EventBridge.

Returns:

Whether UPDATE events from this tracker in EventBridge are enabled. If set to true these events will be 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.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

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.

If you wish to encrypt your data using your own KMS customer managed key, then the Bounding Polygon Queries feature will be disabled by default. This is because by using this feature, a representation of your device positions will not be encrypted using the your KMS managed key. The exact device position, however; is still encrypted using your managed key.

You can choose to opt-in to the Bounding Polygon Quseries feature. This is done by setting the KmsKeyEnableGeospatialQueries parameter to true when creating or updating a Tracker.

kmsKeyId

public final String kmsKeyId()

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.

Returns:

A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.

positionFiltering

public final PositionFiltering positionFiltering()

The position filtering method of the tracker resource.

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:

The position filtering method of the tracker resource.

See Also:

PositionFiltering

positionFilteringAsString

public final String positionFilteringAsString()

The position filtering method of the tracker resource.

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:

The position filtering method of the tracker resource.

See Also:

PositionFiltering

pricingPlan

@Deprecated
public final PricingPlan pricingPlan()

Deprecated.

Deprecated. Always returns RequestBasedUsage.

Always returns 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:

Always returns RequestBasedUsage.

See Also:

PricingPlan

pricingPlanAsString

@Deprecated
public final String pricingPlanAsString()

Deprecated.

Deprecated. Always returns RequestBasedUsage.

Always returns 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:

Always returns RequestBasedUsage.

See Also:

PricingPlan

pricingPlanDataSource

@Deprecated
public final String pricingPlanDataSource()

Deprecated.

Deprecated. Unused.

No longer used. Always returns an empty string.

Returns:

No longer used. Always returns an empty string.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The tags associated with the tracker resource.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags associated with the tracker resource.

trackerArn

public final String trackerArn()

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

Returns:

The Amazon Resource Name (ARN) for the tracker resource. Used when you need to specify a resource across all Amazon Web Services.

• Format example: arn:aws:geo:region:account-id:tracker/ExampleTracker

trackerName

public final String trackerName()

The name of the tracker resource.

Returns:

The name of the tracker resource.

updateTime

public final Instant updateTime()

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

Returns:

The timestamp for when the tracker resource was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

toBuilder

public DescribeTrackerResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTrackerResponse.Builder,DescribeTrackerResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeTrackerResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo