Class CalculateIsolinesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest
software.amazon.awssdk.services.georoutes.model.CalculateIsolinesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>
@Generated("software.amazon.awssdk:codegen") public final class CalculateIsolinesRequest extends GeoRoutesRequest implements ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>

  • Method Details

    • allow

      public final IsolineAllowOptions 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:
      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.

    • arrivalTime

      public final 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

      Returns:
      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

    • avoid

      public final IsolineAvoidanceOptions 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:
      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.

    • departNow

      public final Boolean 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:
      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.

    • departureTime

      public final 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

      Returns:
      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

    • hasDestination

      public final boolean hasDestination()
      For responses, this returns true if the service returned a value for the Destination property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destination

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestination() method.

      Returns:
      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.

    • destinationOptions

      public final 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.

      Returns:
      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.

    • isolineGeometryFormat

      public final GeometryFormat isolineGeometryFormat()

      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      If the service returns an enum value that is not available in the current SDK version, isolineGeometryFormat will return GeometryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from isolineGeometryFormatAsString().

      Returns:
      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      See Also:

    • isolineGeometryFormatAsString

      public final String isolineGeometryFormatAsString()

      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      If the service returns an enum value that is not available in the current SDK version, isolineGeometryFormat will return GeometryFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from isolineGeometryFormatAsString().

      Returns:
      The format of the returned IsolineGeometry.

      Default value:FlexiblePolyline

      See Also:

    • isolineGranularity

      public final 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.

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

    • key

      public final String key()

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

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

    • optimizeIsolineFor

      public final 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

      If the service returns an enum value that is not available in the current SDK version, optimizeIsolineFor will return IsolineOptimizationObjective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizeIsolineForAsString().

      Returns:
      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

      See Also:

    • optimizeIsolineForAsString

      public final String optimizeIsolineForAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, optimizeIsolineFor will return IsolineOptimizationObjective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizeIsolineForAsString().

      Returns:
      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

      See Also:

    • optimizeRoutingFor

      public final RoutingObjective optimizeRoutingFor()

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

      Default value: FastestRoute

      If the service returns an enum value that is not available in the current SDK version, optimizeRoutingFor will return RoutingObjective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizeRoutingForAsString().

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

      Default value: FastestRoute

      See Also:

    • optimizeRoutingForAsString

      public final String optimizeRoutingForAsString()

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

      Default value: FastestRoute

      If the service returns an enum value that is not available in the current SDK version, optimizeRoutingFor will return RoutingObjective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizeRoutingForAsString().

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

      Default value: FastestRoute

      See Also:

    • hasOrigin

      public final boolean hasOrigin()
      For responses, this returns true if the service returned a value for the Origin property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • origin

      public final List<Double> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrigin() method.

      Returns:
      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.

    • originOptions

      public final IsolineOriginOptions 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:
      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.

    • thresholds

      public final IsolineThresholds 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:
      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.

    • traffic

      public final IsolineTrafficOptions traffic()

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

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

    • travelMode

      public final IsolineTravelMode 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

      If the service returns an enum value that is not available in the current SDK version, travelMode will return IsolineTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

      Returns:
      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

      See Also:

    • travelModeAsString

      public final String travelModeAsString()

      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

      If the service returns an enum value that is not available in the current SDK version, travelMode will return IsolineTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

      Returns:
      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

      See Also:

    • travelModeOptions

      public final 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.

      Returns:
      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.

    • toBuilder

      public CalculateIsolinesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>
      Specified by:
      toBuilder in class GeoRoutesRequest
      Returns:
      a builder for type T

    • builder

      public static CalculateIsolinesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CalculateIsolinesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.