Class ForecastedEvent

java.lang.Object
software.amazon.awssdk.services.location.model.ForecastedEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ForecastedEvent.Builder,ForecastedEvent>
@Generated("software.amazon.awssdk:codegen") public final class ForecastedEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ForecastedEvent.Builder,ForecastedEvent>

A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.

See Also:

  • Method Details

    • eventId

      public final String eventId()

      The forecasted event identifier.

      Returns:
      The forecasted event identifier.

    • geofenceId

      public final String geofenceId()

      The geofence identifier pertaining to the forecasted event.

      Returns:
      The geofence identifier pertaining to the forecasted event.

    • isDeviceInGeofence

      public final Boolean isDeviceInGeofence()

      Indicates if the device is located within the geofence.

      Returns:
      Indicates if the device is located within the geofence.

    • nearestDistance

      public final Double nearestDistance()

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

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

    • eventType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, eventType will return ForecastedGeofenceEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      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.

      See Also:

    • eventTypeAsString

      public final String eventTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, eventType will return ForecastedGeofenceEventType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from eventTypeAsString().

      Returns:
      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.

      See Also:

    • forecastedBreachTime

      public final Instant forecastedBreachTime()

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

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

    • hasGeofenceProperties

      public final boolean hasGeofenceProperties()
      For responses, this returns true if the service returned a value for the GeofenceProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • geofenceProperties

      public final Map<String,String> geofenceProperties()

      The geofence properties.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGeofenceProperties() method.

      Returns:
      The geofence properties.

    • toBuilder

      public ForecastedEvent.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ForecastedEvent.Builder,ForecastedEvent>
      Returns:
      a builder for type T

    • builder

      public static ForecastedEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ForecastedEvent.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.