@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ForecastedEvent extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
ForecastedEvent() |
Modifier and Type | Method and Description |
---|---|
ForecastedEvent |
addGeofencePropertiesEntry(String key,
String value)
Add a single GeofenceProperties entry
|
ForecastedEvent |
clearGeofencePropertiesEntries()
Removes all the entries added into GeofenceProperties.
|
ForecastedEvent |
clone() |
boolean |
equals(Object obj) |
String |
getEventId()
The forecasted event identifier.
|
String |
getEventType()
The event type, forecasting three states for which a device can be in relative to a geofence:
|
Date |
getForecastedBreachTime()
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ |
String |
getGeofenceId()
The geofence identifier pertaining to the forecasted event.
|
Map<String,String> |
getGeofenceProperties()
The geofence properties.
|
Boolean |
getIsDeviceInGeofence()
Indicates if the device is located within the geofence.
|
Double |
getNearestDistance()
The closest distance from the device's position to the geofence.
|
int |
hashCode() |
Boolean |
isDeviceInGeofence()
Indicates if the device is located within the geofence.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setEventId(String eventId)
The forecasted event identifier.
|
void |
setEventType(String eventType)
The event type, forecasting three states for which a device can be in relative to a geofence:
|
void |
setForecastedBreachTime(Date forecastedBreachTime)
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ |
void |
setGeofenceId(String geofenceId)
The geofence identifier pertaining to the forecasted event.
|
void |
setGeofenceProperties(Map<String,String> geofenceProperties)
The geofence properties.
|
void |
setIsDeviceInGeofence(Boolean isDeviceInGeofence)
Indicates if the device is located within the geofence.
|
void |
setNearestDistance(Double nearestDistance)
The closest distance from the device's position to the geofence.
|
String |
toString()
Returns a string representation of this object.
|
ForecastedEvent |
withEventId(String eventId)
The forecasted event identifier.
|
ForecastedEvent |
withEventType(ForecastedGeofenceEventType eventType)
The event type, forecasting three states for which a device can be in relative to a geofence:
|
ForecastedEvent |
withEventType(String eventType)
The event type, forecasting three states for which a device can be in relative to a geofence:
|
ForecastedEvent |
withForecastedBreachTime(Date forecastedBreachTime)
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ |
ForecastedEvent |
withGeofenceId(String geofenceId)
The geofence identifier pertaining to the forecasted event.
|
ForecastedEvent |
withGeofenceProperties(Map<String,String> geofenceProperties)
The geofence properties.
|
ForecastedEvent |
withIsDeviceInGeofence(Boolean isDeviceInGeofence)
Indicates if the device is located within the geofence.
|
ForecastedEvent |
withNearestDistance(Double nearestDistance)
The closest distance from the device's position to the geofence.
|
public void setEventId(String eventId)
The forecasted event identifier.
eventId
- The forecasted event identifier.public String getEventId()
The forecasted event identifier.
public ForecastedEvent withEventId(String eventId)
The forecasted event identifier.
eventId
- The forecasted event identifier.public void setGeofenceId(String geofenceId)
The geofence identifier pertaining to the forecasted event.
geofenceId
- The geofence identifier pertaining to the forecasted event.public String getGeofenceId()
The geofence identifier pertaining to the forecasted event.
public ForecastedEvent withGeofenceId(String geofenceId)
The geofence identifier pertaining to the forecasted event.
geofenceId
- The geofence identifier pertaining to the forecasted event.public void setIsDeviceInGeofence(Boolean isDeviceInGeofence)
Indicates if the device is located within the geofence.
isDeviceInGeofence
- Indicates if the device is located within the geofence.public Boolean getIsDeviceInGeofence()
Indicates if the device is located within the geofence.
public ForecastedEvent withIsDeviceInGeofence(Boolean isDeviceInGeofence)
Indicates if the device is located within the geofence.
isDeviceInGeofence
- Indicates if the device is located within the geofence.public Boolean isDeviceInGeofence()
Indicates if the device is located within the geofence.
public void setNearestDistance(Double nearestDistance)
The closest distance from the device's position to the geofence.
nearestDistance
- The closest distance from the device's position to the geofence.public Double getNearestDistance()
The closest distance from the device's position to the geofence.
public ForecastedEvent withNearestDistance(Double nearestDistance)
The closest distance from the device's position to the geofence.
nearestDistance
- The closest distance from the device's position to the geofence.public void setEventType(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.
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.
ForecastedGeofenceEventType
public String getEventType()
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.
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.
ForecastedGeofenceEventType
public ForecastedEvent withEventType(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.
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.
ForecastedGeofenceEventType
public ForecastedEvent withEventType(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.
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.
ForecastedGeofenceEventType
public void setForecastedBreachTime(Date forecastedBreachTime)
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
forecastedBreachTime
- The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
public Date getForecastedBreachTime()
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
YYYY-MM-DDThh:mm:ss.sssZ
public ForecastedEvent withForecastedBreachTime(Date forecastedBreachTime)
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
forecastedBreachTime
- The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
public Map<String,String> getGeofenceProperties()
The geofence properties.
public void setGeofenceProperties(Map<String,String> geofenceProperties)
The geofence properties.
geofenceProperties
- The geofence properties.public ForecastedEvent withGeofenceProperties(Map<String,String> geofenceProperties)
The geofence properties.
geofenceProperties
- The geofence properties.public ForecastedEvent addGeofencePropertiesEntry(String key, String value)
public ForecastedEvent clearGeofencePropertiesEntries()
public String toString()
toString
in class Object
Object.toString()
public ForecastedEvent clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.