Interface DescribeTrackerResponse.Builder
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<DescribeTrackerResponse.Builder,,DescribeTrackerResponse> LocationResponse.Builder,SdkBuilder<DescribeTrackerResponse.Builder,,DescribeTrackerResponse> SdkPojo,SdkResponse.Builder
- Enclosing class:
DescribeTrackerResponse
-
Method Summary
Modifier and TypeMethodDescriptioncreateTime(Instant createTime) The timestamp for when the tracker resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ.description(String description) The optional description for the tracker resource.eventBridgeEnabled(Boolean eventBridgeEnabled) WhetherUPDATEevents from this tracker in EventBridge are enabled.kmsKeyEnableGeospatialQueries(Boolean kmsKeyEnableGeospatialQueries) EnablesGeospatialQueriesfor a tracker that uses a Amazon Web Services KMS customer managed key.A key identifier for an Amazon Web Services KMS customer managed key assigned to the Amazon Location resource.positionFiltering(String positionFiltering) The position filtering method of the tracker resource.positionFiltering(PositionFiltering positionFiltering) The position filtering method of the tracker resource.pricingPlan(String pricingPlan) Deprecated.Deprecated.pricingPlan(PricingPlan pricingPlan) Deprecated.Deprecated.pricingPlanDataSource(String pricingPlanDataSource) Deprecated.Deprecated.The tags associated with the tracker resource.trackerArn(String trackerArn) The Amazon Resource Name (ARN) for the tracker resource.trackerName(String trackerName) The name of the tracker resource.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.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.location.model.LocationResponse.Builder
build, responseMetadata, responseMetadataMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldsMethods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
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.
-
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.
-
-
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.
-
pricingPlan
Deprecated.Deprecated. Always returns RequestBasedUsage.Always returns
RequestBasedUsage.- Parameters:
pricingPlan- Always returnsRequestBasedUsage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pricingPlan
Deprecated.Deprecated. Always returns RequestBasedUsage.Always returns
RequestBasedUsage.- Parameters:
pricingPlan- Always returnsRequestBasedUsage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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.
-
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.
-
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.
-
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
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
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:
-
eventBridgeEnabled
Whether
UPDATEevents from this tracker in EventBridge are enabled. If set totruethese events will be sent to EventBridge.- Parameters:
eventBridgeEnabled- WhetherUPDATEevents from this tracker in EventBridge are enabled. If set totruethese 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
GeospatialQueriesfor 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
KmsKeyEnableGeospatialQueriesparameter to true when creating or updating a Tracker.- Parameters:
kmsKeyEnableGeospatialQueries- EnablesGeospatialQueriesfor 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
KmsKeyEnableGeospatialQueriesparameter to true when creating or updating a Tracker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-