Interface ForecastedEvent.Builder

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

  • Method Details

    • eventId

      ForecastedEvent.Builder eventId(String eventId)

      The forecasted event identifier.

      Parameters:
      eventId - The forecasted event identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geofenceId

      ForecastedEvent.Builder geofenceId(String geofenceId)

      The geofence identifier pertaining to the forecasted event.

      Parameters:
      geofenceId - The geofence identifier pertaining to the forecasted event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isDeviceInGeofence

      ForecastedEvent.Builder isDeviceInGeofence(Boolean isDeviceInGeofence)

      Indicates if the device is located within the geofence.

      Parameters:
      isDeviceInGeofence - Indicates if the device is located within the geofence.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nearestDistance

      ForecastedEvent.Builder nearestDistance(Double nearestDistance)

      The closest distance from the device's position to the geofence.

      Parameters:
      nearestDistance - The closest distance from the device's position to the geofence.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventType

      ForecastedEvent.Builder eventType(String eventType)

      The event type, forecasting three states for which a device can be in relative to a geofence:

      ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      IDLE: If a device is inside of a geofence, and the device is not moving.

      Parameters:
      eventType - The event type, forecasting three states for which a device can be in relative to a geofence:

      ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      IDLE: If a device is inside of a geofence, and the device is not moving.

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

    • eventType

      ForecastedEvent.Builder eventType(ForecastedGeofenceEventType eventType)

      The event type, forecasting three states for which a device can be in relative to a geofence:

      ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      IDLE: If a device is inside of a geofence, and the device is not moving.

      Parameters:
      eventType - The event type, forecasting three states for which a device can be in relative to a geofence:

      ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

      IDLE: If a device is inside of a geofence, and the device is not moving.

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

    • forecastedBreachTime

      ForecastedEvent.Builder forecastedBreachTime(Instant forecastedBreachTime)

      The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

      Parameters:
      forecastedBreachTime - The forecasted time the device will breach the geofence 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.

    • geofenceProperties

      ForecastedEvent.Builder geofenceProperties(Map<String,String> geofenceProperties)

      The geofence properties.

      Parameters:
      geofenceProperties - The geofence properties.
      Returns:
      Returns a reference to this object so that method calls can be chained together.