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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-locationservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#collection_name ⇒ String

The name of the geofence collection.

Returns:

  • (String) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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

The device’s state, including current position and speed.

Returns:



3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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

Specifies the time horizon in minutes for the forecasted events.

Returns:

  • (Float) 


3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/aws-sdk-locationservice/types.rb', line 3050

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