Class: Aws::GeoRoutes::Types::CalculateRouteMatrixRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:key]

Instance Attribute Summary collapse

Instance Attribute Details

#allow ⇒ Types::RouteMatrixAllowOptions

Features that are allowed while calculating. a route

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#avoid ⇒ Types::RouteMatrixAvoidanceOptions

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:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#depart_now ⇒ Boolean

Uses the current time as the time of departure.

Returns:

  • (Boolean) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  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) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#destinations ⇒ Array<Types::RouteMatrixDestination>

List of destinations for the route.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#exclude ⇒ Types::RouteMatrixExclusionOptions

Features to be strictly excluded while calculating the route.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  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) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#optimize_routing_for ⇒ String

Specifies the optimization criteria for calculating a route.

Default Value: ‘FastestRoute`

Returns:

  • (String) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#origins ⇒ Array<Types::RouteMatrixOrigin>

The position in longitude and latitude for the origin.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#routing_boundary ⇒ Types::RouteMatrixBoundary

Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

<note markdown=“1”> When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

</note>

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#traffic ⇒ Types::RouteMatrixTrafficOptions

Traffic related options.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  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.

Default Value: ‘Car`

Returns:

  • (String) 


309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end

#travel_mode_options ⇒ Types::RouteMatrixTravelModeOptions

Travel mode related options for the provided travel mode.

Returns:



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/aws-sdk-georoutes/types.rb', line 309

class CalculateRouteMatrixRequest < Struct.new(
  :allow,
  :avoid,
  :depart_now,
  :departure_time,
  :destinations,
  :exclude,
  :key,
  :optimize_routing_for,
  :origins,
  :routing_boundary,
  :traffic,
  :travel_mode,
  :travel_mode_options)
  SENSITIVE = [:key]
  include Aws::Structure
end