Interface CalculateIsolinesRequest.Builder

  • Method Details

    • allow

      Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.

      Parameters:
      allow - Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • allow

      Enables special road types or features that should be considered for routing even if they might be restricted by default for the selected travel mode. These include high-occupancy vehicle and toll lanes.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to allow(IsolineAllowOptions).

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

      CalculateIsolinesRequest.Builder arrivalTime(String arrivalTime)

      Determine areas from which Destination can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with DepartureTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.

      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 - Determine areas from which Destination can be reached by this time, taking into account predicted traffic conditions and working backward to account for congestion patterns. This attribute cannot be used together with DepartureTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.

      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.
    • avoid

      Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.

      Parameters:
      avoid - Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • avoid

      Specifies road types, features, or areas to avoid (if possible) when calculating reachable areas. These are treated as preferences rather than strict constraints—if a route cannot be calculated without using an avoided feature, that avoidance preference may be ignored.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to avoid(IsolineAvoidanceOptions).

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

      When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with DepartureTime or ArrivalTime.

      Parameters:
      departNow - When true, uses the current time as the departure time and takes current traffic conditions into account. This attribute cannot be used together with DepartureTime or ArrivalTime.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • departureTime

      CalculateIsolinesRequest.Builder departureTime(String departureTime)

      Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with ArrivalTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.

      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 - Determine areas that can be reached when departing at this time, taking into account predicted traffic conditions. This attribute cannot be used together with ArrivalTime or DepartNow. Specified as an ISO-8601 timestamp with timezone offset.

      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.
    • destination

      An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.

      Parameters:
      destination - An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • destination

      CalculateIsolinesRequest.Builder destination(Double... destination)

      An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.

      Parameters:
      destination - An optional destination point, specified as [longitude, latitude] coordinates. When provided, the service calculates areas from which this destination can be reached within the specified thresholds. This reverses the usual isoline calculation to show areas that could reach your location, rather than areas you could reach from your location. Either Origin or Destination must be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • destinationOptions

      CalculateIsolinesRequest.Builder destinationOptions(IsolineDestinationOptions destinationOptions)

      Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.

      Parameters:
      destinationOptions - Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • destinationOptions

      default CalculateIsolinesRequest.Builder destinationOptions(Consumer<IsolineDestinationOptions.Builder> destinationOptions)

      Options that control how the destination point is matched to the road network and how routes can approach it. These options help improve travel time accuracy by accounting for real-world access to the destination.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationOptions(IsolineDestinationOptions).

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

      CalculateIsolinesRequest.Builder isolineGeometryFormat(String isolineGeometryFormat)

      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      Parameters:
      isolineGeometryFormat - The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • isolineGeometryFormat

      CalculateIsolinesRequest.Builder isolineGeometryFormat(GeometryFormat isolineGeometryFormat)

      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      Parameters:
      isolineGeometryFormat - The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • isolineGranularity

      CalculateIsolinesRequest.Builder isolineGranularity(IsolineGranularityOptions isolineGranularity)

      Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.

      Parameters:
      isolineGranularity - Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isolineGranularity

      default CalculateIsolinesRequest.Builder isolineGranularity(Consumer<IsolineGranularityOptions.Builder> isolineGranularity)

      Controls the detail level of the generated isolines. Higher granularity produces smoother shapes but requires more processing time and results in larger responses.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to isolineGranularity(IsolineGranularityOptions).

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

      An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.

      Parameters:
      key - An Amazon Location Service API Key with access to this action. If omitted, the request must be signed using Signature Version 4.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • optimizeIsolineFor

      CalculateIsolinesRequest.Builder optimizeIsolineFor(String optimizeIsolineFor)

      Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.

      Default value: BalancedCalculation

      Parameters:
      optimizeIsolineFor - Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.

      Default value: BalancedCalculation

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • optimizeIsolineFor

      CalculateIsolinesRequest.Builder optimizeIsolineFor(IsolineOptimizationObjective optimizeIsolineFor)

      Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.

      Default value: BalancedCalculation

      Parameters:
      optimizeIsolineFor - Controls the trade-off between calculation speed and isoline precision. Choose FastCalculation for quicker results with less detail, AccurateCalculation for more precise results, or BalancedCalculation for a middle ground.

      Default value: BalancedCalculation

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • optimizeRoutingFor

      CalculateIsolinesRequest.Builder optimizeRoutingFor(String optimizeRoutingFor)

      Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.

      Default value: FastestRoute

      Parameters:
      optimizeRoutingFor - Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.

      Default value: FastestRoute

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • optimizeRoutingFor

      CalculateIsolinesRequest.Builder optimizeRoutingFor(RoutingObjective optimizeRoutingFor)

      Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.

      Default value: FastestRoute

      Parameters:
      optimizeRoutingFor - Determines whether routes prioritize shortest travel time (FastestRoute) or shortest physical distance (ShortestRoute) when calculating reachable areas.

      Default value: FastestRoute

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • origin

      The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.

      Parameters:
      origin - The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • origin

      The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.

      Parameters:
      origin - The starting point for isoline calculations, specified as [longitude, latitude] coordinates. For example, this could be a store location, service center, or any point from which you want to calculate reachable areas. Either Origin or Destination must be provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • originOptions

      Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.

      Parameters:
      originOptions - Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • originOptions

      Options that control how the origin point is matched to the road network and how routes can depart from it. These options help improve travel time accuracy by accounting for real-world access from the origin.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to originOptions(IsolineOriginOptions).

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

      The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.

      You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.

      Parameters:
      thresholds - The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.

      You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • thresholds

      The distance or time thresholds used to determine reachable areas. You can specify up to five thresholds (which all must be the same type) to calculate multiple isolines in a single request. For example, to determine the areas that are reachable within 10 and 20 minutes of the origin, specify time thresholds of 600 and 1200 seconds.

      You incur a calculation charge for each threshold. Using a large number of thresholds in a request can lead to unexpected charges. For more information, see Routes pricing in the Amazon Location Service Developer Guide.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to thresholds(IsolineThresholds).

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

      Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.

      Parameters:
      traffic - Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • traffic

      Configures how real-time and historical traffic data affects isoline calculations. Traffic patterns can significantly impact reachable areas, especially during peak hours.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to traffic(IsolineTrafficOptions).

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

      CalculateIsolinesRequest.Builder travelMode(String travelMode)

      The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.

      • Car—Standard passenger vehicle routing using roads accessible to cars

      • Pedestrian—Walking routes using pedestrian paths, sidewalks, and crossings

      • Scooter—Light two-wheeled vehicle routing using roads and paths accessible to scooters

      • Truck—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations

      The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.

      Default value: Car

      Parameters:
      travelMode - The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.

      • Car—Standard passenger vehicle routing using roads accessible to cars

      • Pedestrian—Walking routes using pedestrian paths, sidewalks, and crossings

      • Scooter—Light two-wheeled vehicle routing using roads and paths accessible to scooters

      • Truck—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations

      The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.

      Default value: Car

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • travelMode

      The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.

      • Car—Standard passenger vehicle routing using roads accessible to cars

      • Pedestrian—Walking routes using pedestrian paths, sidewalks, and crossings

      • Scooter—Light two-wheeled vehicle routing using roads and paths accessible to scooters

      • Truck—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations

      The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.

      Default value: Car

      Parameters:
      travelMode - The mode of transportation to use for calculations. This affects which road types or features can be used, estimated speed, and the traffic levels that are applied.

      • Car—Standard passenger vehicle routing using roads accessible to cars

      • Pedestrian—Walking routes using pedestrian paths, sidewalks, and crossings

      • Scooter—Light two-wheeled vehicle routing using roads and paths accessible to scooters

      • Truck—Commercial truck routing considering vehicle dimensions, weight restrictions, and hazardous material regulations

      The mode Scooter also applies to motorcycles; set this to Scooter when calculating isolines for motorcycles.

      Default value: Car

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • travelModeOptions

      CalculateIsolinesRequest.Builder travelModeOptions(IsolineTravelModeOptions travelModeOptions)

      Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.

      For example:

      • For trucks (Truck), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle

      • For cars (Car), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas

      • For scooters (Scooter), specify engine type and speed limitations to more accurately model their travel capabilities

      Without these options, calculations use default assumptions that may not match your specific use case.

      Parameters:
      travelModeOptions - Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.

      For example:

      • For trucks (Truck), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle

      • For cars (Car), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas

      • For scooters (Scooter), specify engine type and speed limitations to more accurately model their travel capabilities

      Without these options, calculations use default assumptions that may not match your specific use case.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • travelModeOptions

      default CalculateIsolinesRequest.Builder travelModeOptions(Consumer<IsolineTravelModeOptions.Builder> travelModeOptions)

      Additional attributes that refine how reachable areas are calculated based on specific vehicle characteristics. These options help produce more accurate results by accounting for real-world constraints and capabilities.

      For example:

      • For trucks (Truck), specify dimensions, weight limits, and hazardous cargo restrictions to ensure isolines only include roads that can physically and legally accommodate the vehicle

      • For cars (Car), set maximum speed capabilities or indicate high-occupancy vehicle eligibility to better estimate reachable areas

      • For scooters (Scooter), specify engine type and speed limitations to more accurately model their travel capabilities

      Without these options, calculations use default assumptions that may not match your specific use case.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to travelModeOptions(IsolineTravelModeOptions).

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

      CalculateIsolinesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.