Class: Aws::LocationService::Types::ForecastGeofenceEventsRequest

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::ForecastGeofenceEventsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_name ⇒ String

  The name of the geofence collection.

• #device_state ⇒ Types::ForecastGeofenceEventsDeviceState

  Represents the device’s state, including its current position and speed.

• #distance_unit ⇒ String

  The distance unit used for the ‘NearestDistance` property returned in a forecasted event.

• #max_results ⇒ Integer

  An optional limit for the number of resources returned in a single call.

• #next_token ⇒ String

  The pagination token specifying which page of results to return in the response.

• #speed_unit ⇒ String

  The speed unit for the device captured by the device state.

• #time_horizon_minutes ⇒ Float

  The forward-looking time window for forecasting, specified in minutes.

Instance Attribute Details

#collection_name ⇒ String

The name of the geofence collection.

Returns:

• (String)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#device_state ⇒ Types::ForecastGeofenceEventsDeviceState

Represents the device’s state, including its current position and speed. When speed is omitted, this API performs a *containment check*. The *containment check* operation returns ‘IDLE` events for geofences where the device is currently inside of, but no other events.

Returns:

• (Types::ForecastGeofenceEventsDeviceState)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#distance_unit ⇒ String

The distance unit used for the ‘NearestDistance` property returned in a forecasted event. The measurement system must match for `DistanceUnit` and `SpeedUnit`; if `Kilometers` is specified for `DistanceUnit`, then `SpeedUnit` must be `KilometersPerHour`.

Default Value: ‘Kilometers`

Returns:

• (String)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

An optional limit for the number of resources returned in a single call.

Default value: ‘20`

Returns:

• (Integer)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: ‘null`

Returns:

• (String)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#speed_unit ⇒ String

The speed unit for the device captured by the device state. The measurement system must match for ‘DistanceUnit` and `SpeedUnit`; if `Kilometers` is specified for `DistanceUnit`, then `SpeedUnit` must be `KilometersPerHour`.

Default Value: ‘KilometersPerHour`.

Returns:

• (String)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#time_horizon_minutes ⇒ Float

The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a *containment check*. The *containment check* operation returns ‘IDLE` events for geofences where the device is currently inside of, but no other events.

Returns:

• (Float)

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

class ForecastGeofenceEventsRequest < Struct.new(
  :collection_name,
  :device_state,
  :time_horizon_minutes,
  :distance_unit,
  :speed_unit,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end