Class: Aws::LocationService::Types::ForecastedEvent

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::ForecastedEvent

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:geofence_properties]

Instance Attribute Summary

• #event_id ⇒ String

  The forecasted event identifier.

• #event_type ⇒ String

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

• #forecasted_breach_time ⇒ Time

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

• #geofence_id ⇒ String

  The geofence identifier pertaining to the forecasted event.

• #geofence_properties ⇒ Hash<String,String>

  The geofence properties.

• #is_device_in_geofence ⇒ Boolean

  Indicates if the device is located within the geofence.

• #nearest_distance ⇒ Float

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

Instance Attribute Details

#event_id ⇒ String

The forecasted event identifier.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#event_type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#forecasted_breach_time ⇒ Time

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

[1]: www.iso.org/iso-8601-date-and-time-format.html

Returns:

• (Time)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_id ⇒ String

The geofence identifier pertaining to the forecasted event.

Returns:

• (String)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#geofence_properties ⇒ Hash<String,String>

The geofence properties.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#is_device_in_geofence ⇒ Boolean

Indicates if the device is located within the geofence.

Returns:

• (Boolean)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end

#nearest_distance ⇒ Float

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

Returns:

• (Float)

# File 'lib/aws-sdk-locationservice/types.rb', line 3144

class ForecastedEvent < Struct.new(
  :event_id,
  :geofence_id,
  :is_device_in_geofence,
  :nearest_distance,
  :event_type,
  :forecasted_breach_time,
  :geofence_properties)
  SENSITIVE = [:geofence_properties]
  include Aws::Structure
end