Interface CalculateIsolinesResponse.Builder

  • Method Details

    • arrivalTime

      CalculateIsolinesResponse.Builder arrivalTime(String arrivalTime)

      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

      Parameters:
      arrivalTime - 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:
      Returns a reference to this object so that method calls can be chained together.
    • departureTime

      CalculateIsolinesResponse.Builder departureTime(String departureTime)

      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

      Parameters:
      departureTime - 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:
      Returns a reference to this object so that method calls can be chained together.
    • isolineGeometryFormat

      CalculateIsolinesResponse.Builder isolineGeometryFormat(String isolineGeometryFormat)

      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

      Parameters:
      isolineGeometryFormat - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • isolineGeometryFormat

      CalculateIsolinesResponse.Builder isolineGeometryFormat(GeometryFormat isolineGeometryFormat)

      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

      Parameters:
      isolineGeometryFormat - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • isolines

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

      Parameters:
      isolines - Reachable areas, or isolines, for each threshold specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isolines

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

      Parameters:
      isolines - Reachable areas, or isolines, for each threshold specified in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isolines

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

      This is a convenience method that creates an instance of the Isoline.Builder avoiding the need to create one manually via Isoline.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to isolines(List<Isoline>).

      Parameters:
      isolines - a consumer that will call methods on Isoline.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • pricingBucket

      CalculateIsolinesResponse.Builder pricingBucket(String pricingBucket)

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

      Parameters:
      pricingBucket - The pricing bucket applied to this calculation. Different buckets apply based on the travel mode and thresholds used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDestination

      CalculateIsolinesResponse.Builder snappedDestination(Collection<Double> snappedDestination)

      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.

      Parameters:
      snappedDestination - 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:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDestination

      CalculateIsolinesResponse.Builder snappedDestination(Double... snappedDestination)

      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.

      Parameters:
      snappedDestination - 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:
      Returns a reference to this object so that method calls can be chained together.
    • snappedOrigin

      CalculateIsolinesResponse.Builder snappedOrigin(Collection<Double> snappedOrigin)

      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.

      Parameters:
      snappedOrigin - 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:
      Returns a reference to this object so that method calls can be chained together.
    • snappedOrigin

      CalculateIsolinesResponse.Builder snappedOrigin(Double... snappedOrigin)

      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.

      Parameters:
      snappedOrigin - 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:
      Returns a reference to this object so that method calls can be chained together.