Interface GetDevicePositionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetDevicePositionResponse.Builder,GetDevicePositionResponse>, LocationResponse.Builder, SdkBuilder<GetDevicePositionResponse.Builder,GetDevicePositionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetDevicePositionResponse
public static interface GetDevicePositionResponse.Builder extends LocationResponse.Builder, SdkPojo, CopyableBuilder<GetDevicePositionResponse.Builder,GetDevicePositionResponse>

  • Method Details

    • deviceId

      GetDevicePositionResponse.Builder deviceId(String deviceId)

      The device whose position you retrieved.

      Parameters:
      deviceId - The device whose position you retrieved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleTime

      GetDevicePositionResponse.Builder sampleTime(Instant sampleTime)

      The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

      Parameters:
      sampleTime - The timestamp at which the device's position was determined. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • receivedTime

      GetDevicePositionResponse.Builder receivedTime(Instant receivedTime)

      The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

      Parameters:
      receivedTime - The timestamp for when the tracker resource received the device position. Uses ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      GetDevicePositionResponse.Builder position(Collection<Double> position)

      The last known device position.

      Parameters:
      position - The last known device position.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • position

      GetDevicePositionResponse.Builder position(Double... position)

      The last known device position.

      Parameters:
      position - The last known device position.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accuracy

      GetDevicePositionResponse.Builder accuracy(PositionalAccuracy accuracy)

      The accuracy of the device position.

      Parameters:
      accuracy - The accuracy of the device position.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accuracy

      default GetDevicePositionResponse.Builder accuracy(Consumer<PositionalAccuracy.Builder> accuracy)

      The accuracy of the device position.

      This is a convenience method that creates an instance of the PositionalAccuracy.Builder avoiding the need to create one manually via PositionalAccuracy.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accuracy(PositionalAccuracy).

      Parameters:
      accuracy - a consumer that will call methods on PositionalAccuracy.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • positionProperties

      GetDevicePositionResponse.Builder positionProperties(Map<String,String> positionProperties)

      The properties associated with the position.

      Parameters:
      positionProperties - The properties associated with the position.
      Returns:
      Returns a reference to this object so that method calls can be chained together.