Class: Aws::GeoRoutes::Types::CalculateIsolinesResponse

Inherits:

Struct

• Object
• Struct
• Aws::GeoRoutes::Types::CalculateIsolinesResponse

Includes:

Structure

Defined in:

lib/aws-sdk-georoutes/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:arrival_time, :departure_time, :snapped_destination, :snapped_origin]

Instance Attribute Summary

• #arrival_time ⇒ String

  Time of arrival at the destination, used for traffic calculations.

• #departure_time ⇒ String

  Time of departure from the origin, used for traffic calculations.

• #isoline_geometry_format ⇒ String

  The format of the returned geometries, matching the format specified in the request.

• #isolines ⇒ Array<Types::Isoline>

  Reachable areas, or isolines, for each threshold specified in the request.

• #pricing_bucket ⇒ String

  The pricing bucket applied to this calculation.

• #snapped_destination ⇒ Array<Float>

  The actual point on the road network used for calculations, which may differ from the requested destination if ‘Destination` was not directly on a road.

• #snapped_origin ⇒ Array<Float>

  The actual point on the road network used for calculations, which may differ from the requested origin if ‘Origin` was not directly on a road.

Instance Attribute Details

#arrival_time ⇒ String

Time of arrival at the destination, used for traffic calculations. This attribute is returned only if the ‘Destination` and `ArrivalTime` attributes were provided in the request.

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)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#departure_time ⇒ String

Time of departure from the origin, used for traffic calculations. This attribute is returned when ‘Origin` was provided in the request and either a specific departure time was requested (`DepartureTime`) or `DepartNow` was set to true.

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)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#isoline_geometry_format ⇒ String

The format of the returned geometries, matching the format specified in the request. Either ‘ FlexiblePolyline` for compact encoding or `Simple` for GeoJSON-compatible coordinates.

Default value:‘FlexiblePolyline`

Returns:

• (String)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#isolines ⇒ Array<Types::Isoline>

Reachable areas, or isolines, for each threshold specified in the request.

Returns:

• (Array<Types::Isoline>)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#pricing_bucket ⇒ String

The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.

Returns:

• (String)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#snapped_destination ⇒ Array<Float>

The actual point on the road network used for calculations, which may differ from the requested destination if ‘Destination` was not directly on a road.

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end

#snapped_origin ⇒ Array<Float>

The actual point on the road network used for calculations, which may differ from the requested origin if ‘Origin` was not directly on a road.

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-georoutes/types.rb', line 303

class CalculateIsolinesResponse < Struct.new(
  :arrival_time,
  :departure_time,
  :isoline_geometry_format,
  :isolines,
  :pricing_bucket,
  :snapped_destination,
  :snapped_origin)
  SENSITIVE = [:arrival_time, :departure_time, :snapped_destination, :snapped_origin]
  include Aws::Structure
end