Interface DevicePosition.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DevicePosition.Builder,DevicePosition>, SdkBuilder<DevicePosition.Builder,DevicePosition>, SdkPojo
Enclosing class:
DevicePosition
public static interface DevicePosition.Builder extends SdkPojo, CopyableBuilder<DevicePosition.Builder,DevicePosition>

  • Method Details

    • deviceId

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

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

      DevicePosition.Builder receivedTime(Instant receivedTime)

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

      Parameters:
      receivedTime - The timestamp for when the tracker resource received the device position 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.

    • position

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

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

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

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