software.amazon.awssdk.services.location.model

Interface DescribeTrackerResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeTrackerResponse.Builder,DescribeTrackerResponse>, LocationResponse.Builder, SdkBuilder<DescribeTrackerResponse.Builder,DescribeTrackerResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeTrackerResponse

public static interface DescribeTrackerResponse.Builder
extends LocationResponse.Builder, SdkPojo, CopyableBuilder<DescribeTrackerResponse.Builder,DescribeTrackerResponse>

Method Summary

Modifier and Type	Method and Description
DescribeTrackerResponse.Builder	createTime(Instant createTime) The timestamp for when the tracker resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
DescribeTrackerResponse.Builder	description(String description) The optional description for the tracker resource.
DescribeTrackerResponse.Builder	eventBridgeEnabled(Boolean eventBridgeEnabled) Whether UPDATE events from this tracker in EventBridge are enabled.
DescribeTrackerResponse.Builder	kmsKeyEnableGeospatialQueries(Boolean kmsKeyEnableGeospatialQueries) Enables GeospatialQueries for a tracker that uses a Amazon Web Services KMS customer managed key.
DescribeTrackerResponse.Builder	kmsKeyId(String kmsKeyId) A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.
DescribeTrackerResponse.Builder	positionFiltering(PositionFiltering positionFiltering) The position filtering method of the tracker resource.
DescribeTrackerResponse.Builder	positionFiltering(String positionFiltering) The position filtering method of the tracker resource.
DescribeTrackerResponse.Builder	pricingPlan(PricingPlan pricingPlan) Deprecated. Deprecated. Always returns RequestBasedUsage.
DescribeTrackerResponse.Builder	pricingPlan(String pricingPlan) Deprecated. Deprecated. Always returns RequestBasedUsage.
DescribeTrackerResponse.Builder	pricingPlanDataSource(String pricingPlanDataSource) Deprecated. Deprecated. Unused.
DescribeTrackerResponse.Builder	tags(Map<String,String> tags) The tags associated with the tracker resource.
DescribeTrackerResponse.Builder	trackerArn(String trackerArn) The Amazon Resource Name (ARN) for the tracker resource.
DescribeTrackerResponse.Builder	trackerName(String trackerName) The name of the tracker resource.
DescribeTrackerResponse.Builder	updateTime(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 interface software.amazon.awssdk.services.location.model.LocationResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

createTime

DescribeTrackerResponse.Builder createTime(Instant createTime)

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

Parameters:

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

Returns:

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

description

DescribeTrackerResponse.Builder description(String description)

The optional description for the tracker resource.

Parameters:

description - The optional description for the tracker resource.

Returns:

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

eventBridgeEnabled

DescribeTrackerResponse.Builder eventBridgeEnabled(Boolean eventBridgeEnabled)

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

Parameters:

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

Returns:

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

kmsKeyEnableGeospatialQueries

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

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.

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.

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:

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

kmsKeyId

DescribeTrackerResponse.Builder kmsKeyId(String kmsKeyId)

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

Parameters:

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

Returns:

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

positionFiltering

DescribeTrackerResponse.Builder positionFiltering(String positionFiltering)

The position filtering method of the tracker resource.

Parameters:

positionFiltering - The position filtering method of the tracker resource.

Returns:

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

See Also:

PositionFiltering, PositionFiltering

positionFiltering

DescribeTrackerResponse.Builder positionFiltering(PositionFiltering positionFiltering)

The position filtering method of the tracker resource.

Parameters:

positionFiltering - The position filtering method of the tracker resource.

Returns:

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

See Also:

PositionFiltering, PositionFiltering

pricingPlan

@Deprecated
DescribeTrackerResponse.Builder pricingPlan(String pricingPlan)

Deprecated. Deprecated. Always returns RequestBasedUsage.

Always returns RequestBasedUsage.

Parameters:

pricingPlan - Always returns RequestBasedUsage.

Returns:

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

See Also:

PricingPlan, PricingPlan

pricingPlan

@Deprecated
DescribeTrackerResponse.Builder pricingPlan(PricingPlan pricingPlan)

Deprecated. Deprecated. Always returns RequestBasedUsage.

Always returns RequestBasedUsage.

Parameters:

pricingPlan - Always returns RequestBasedUsage.

Returns:

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

See Also:

PricingPlan, PricingPlan

pricingPlanDataSource

@Deprecated
DescribeTrackerResponse.Builder pricingPlanDataSource(String pricingPlanDataSource)

Deprecated. Deprecated. Unused.

No longer used. Always returns an empty string.

Parameters:

pricingPlanDataSource - No longer used. Always returns an empty string.

Returns:

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

tags

DescribeTrackerResponse.Builder tags(Map<String,String> tags)

The tags associated with the tracker resource.

Parameters:

tags - The tags associated with the tracker resource.

Returns:

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

trackerArn

DescribeTrackerResponse.Builder trackerArn(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

Parameters:

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:

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

trackerName

DescribeTrackerResponse.Builder trackerName(String trackerName)

The name of the tracker resource.

Parameters:

trackerName - The name of the tracker resource.

Returns:

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

updateTime

DescribeTrackerResponse.Builder updateTime(Instant updateTime)

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

Parameters:

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

Returns:

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