Class: Aws::GeoRoutes::Types::CalculateIsolinesRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:destination, :key, :origin]

Instance Attribute Summary collapse

Instance Attribute Details

#allow ⇒ Types::IsolineAllowOptions

Features that are allowed while calculating. a route

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#arrival_time ⇒ String

Time of arrival at the destination.

Time format: ‘YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm`

Examples:

‘2020-04-22T17:57:24Z`

‘2020-04-22T17:57:24+02:00`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#avoid ⇒ Types::IsolineAvoidanceOptions

Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can’t be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#depart_now ⇒ Boolean

Uses the current time as the time of departure.

Returns:

  • (Boolean) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#departure_time ⇒ String

Time of departure from thr origin.

Time format:‘YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm`

Examples:

‘2020-04-22T17:57:24Z`

‘2020-04-22T17:57:24+02:00`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#destination ⇒ Array<Float>

The final position for the route. In the World Geodetic System (WGS 84) format: ‘[longitude, latitude]`.

Returns:

  • (Array<Float>) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#destination_options ⇒ Types::IsolineDestinationOptions

Destination related options.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#isoline_geometry_format ⇒ String

The format of the returned IsolineGeometry.

Default Value:‘FlexiblePolyline`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#isoline_granularity ⇒ Types::IsolineGranularityOptions

Defines the granularity of the returned Isoline

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#key ⇒ String

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#optimize_isoline_for ⇒ String

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: ‘BalancedCalculation`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#optimize_routing_for ⇒ String

Specifies the optimization criteria for calculating a route.

Default Value: ‘FastestRoute`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#origin ⇒ Array<Float>

The start position for the route.

Returns:

  • (Array<Float>) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#origin_options ⇒ Types::IsolineOriginOptions

Origin related options.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#thresholds ⇒ Types::IsolineThresholds

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#traffic ⇒ Types::IsolineTrafficOptions

Traffic related options.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#travel_mode ⇒ String

Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

<note markdown=“1”> The mode ‘Scooter` also applies to motorcycles, set to `Scooter` when wanted to calculate options for motorcycles.

</note>

Default Value: ‘Car`

Returns:

  • (String) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end

#travel_mode_options ⇒ Types::IsolineTravelModeOptions

Travel mode related options for the provided travel mode.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/aws-sdk-georoutes/types.rb', line 143

class CalculateIsolinesRequest < Struct.new(
  :allow,
  :arrival_time,
  :avoid,
  :depart_now,
  :departure_time,
  :destination,
  :destination_options,
  :isoline_geometry_format,
  :isoline_granularity,
  :key,
  :optimize_isoline_for,
  :optimize_routing_for,
  :origin,
  :origin_options,
  :thresholds,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:destination, :key, :origin]
  include Aws::Structure
end