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

Interface DescribeTrackerResponse.Builder

    • Method Detail

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

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

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

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

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

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

      • 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

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