CalculateRouteRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.location.model.LocationRequest
    - - software.amazon.awssdk.services.location.model.CalculateRouteRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CalculateRouteRequest
extends LocationRequest
implements ToCopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CalculateRouteRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CalculateRouteRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CalculateRouteRequest.Builder`	`builder()`
`String`	`calculatorName()` The name of the route calculator resource that you want to use to calculate a route.
`CalculateRouteCarModeOptions`	`carModeOptions()` Specifies route preferences when traveling by `Car`, such as avoiding routes that use ferries or tolls.
`Boolean`	`departNow()` Sets the time of departure as the current time.
`List<Double>`	`departurePosition()` The start position for the route.
`Instant`	`departureTime()` Specifies the desired time of departure.
`List<Double>`	`destinationPosition()` The finish position for the route.
`DistanceUnit`	`distanceUnit()` Set the unit system to specify the distance.
`String`	`distanceUnitAsString()` Set the unit system to specify the distance.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDeparturePosition()` For responses, this returns true if the service returned a value for the DeparturePosition property.
`boolean`	`hasDestinationPosition()` For responses, this returns true if the service returned a value for the DestinationPosition property.
`int`	`hashCode()`
`boolean`	`hasWaypointPositions()` For responses, this returns true if the service returned a value for the WaypointPositions property.
`Boolean`	`includeLegGeometry()` Set to include the geometry details in the result for each path between a pair of positions.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CalculateRouteRequest.Builder>`	`serializableBuilderClass()`
`CalculateRouteRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`TravelMode`	`travelMode()` Specifies the mode of transport when calculating a route.
`String`	`travelModeAsString()` Specifies the mode of transport when calculating a route.
`CalculateRouteTruckModeOptions`	`truckModeOptions()` Specifies route preferences when traveling by `Truck`, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
`List<List<Double>>`	`waypointPositions()` Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - calculatorName
```
public final String calculatorName()
```
    The name of the route calculator resource that you want to use to calculate a route.
    
    Returns:
    
    The name of the route calculator resource that you want to use to calculate a route.
  - carModeOptions
```
public final CalculateRouteCarModeOptions carModeOptions()
```
    Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
    
    Requirements: TravelMode must be specified as Car.
    
    Returns:
    
    Specifies route preferences when traveling by Car, such as avoiding routes that use ferries or tolls.
    
    Requirements: TravelMode must be specified as Car.
  - departNow
```
public final Boolean departNow()
```
    Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Sets the time of departure as the current time. Uses the current time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
    
    Default Value: false
    
    Valid Values: false | true
  - hasDeparturePosition
```
public final boolean hasDeparturePosition()
```
    For responses, this returns true if the service returned a value for the DeparturePosition 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.
  - departurePosition
```
public final List<Double> departurePosition()
```
    The start position for the route. Defined in WGS 84 format: [longitude, latitude].
    - For example, [-123.115, 49.285]
    If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
    
    Valid Values: [-180 to 180,-90 to 90]
    
    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 hasDeparturePosition() method.
    Returns:
    The start position for the route. Defined in WGS 84 format: [longitude, latitude].
    
    For example, [-123.115, 49.285]
    
    If you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
    
    Valid Values: [-180 to 180,-90 to 90]
  - departureTime
```
public final Instant departureTime()
```
    Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
    
    Setting a departure time in the past returns a 400 ValidationException error.
    - In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
    Returns:
    Specifies the desired time of departure. Uses the given time to calculate a route. Otherwise, the best time of day to travel with the best traffic conditions is used to calculate the route.
    
    Setting a departure time in the past returns a 400 ValidationException error.
    
    In ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. For example, 2020–07-2T12:15:20.000Z+01:00
  - hasDestinationPosition
```
public final boolean hasDestinationPosition()
```
    For responses, this returns true if the service returned a value for the DestinationPosition 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.
  - destinationPosition
```
public final List<Double> destinationPosition()
```
    The finish position for the route. Defined in WGS 84 format: [longitude, latitude].
    - For example, [-122.339, 47.615]
    If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
    
    Valid Values: [-180 to 180,-90 to 90]
    
    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 hasDestinationPosition() method.
    Returns:
    The finish position for the route. Defined in WGS 84 format: [longitude, latitude].
    
    For example, [-122.339, 47.615]
    
    If you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road.
    
    Valid Values: [-180 to 180,-90 to 90]
  - distanceUnit
```
public final DistanceUnit distanceUnit()
```
    Set the unit system to specify the distance.
    
    Default Value: Kilometers
    
    If the service returns an enum value that is not available in the current SDK version, distanceUnit will return DistanceUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distanceUnitAsString().
    
    Returns:
    
    Set the unit system to specify the distance.
    
    Default Value: Kilometers
    
    See Also:
    
    DistanceUnit
  - distanceUnitAsString
```
public final String distanceUnitAsString()
```
    Set the unit system to specify the distance.
    
    Default Value: Kilometers
    
    If the service returns an enum value that is not available in the current SDK version, distanceUnit will return DistanceUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distanceUnitAsString().
    
    Returns:
    
    Set the unit system to specify the distance.
    
    Default Value: Kilometers
    
    See Also:
    
    DistanceUnit
  - includeLegGeometry
```
public final Boolean includeLegGeometry()
```
    Set to include the geometry details in the result for each path between a pair of positions.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Set to include the geometry details in the result for each path between a pair of positions.
    
    Default Value: false
    
    Valid Values: false | true
  - travelMode
```
public final TravelMode travelMode()
```
    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
    
    The TravelMode you specify determines how you specify route preferences:
    - If traveling by Car use the CarModeOptions parameter.
    - If traveling by Truck use the TruckModeOptions parameter.
    Default Value: Car
    
    If the service returns an enum value that is not available in the current SDK version, travelMode will return TravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().
    Returns:
    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
    
    The TravelMode you specify determines how you specify route preferences:
    
    If traveling by Car use the CarModeOptions parameter.
    
    If traveling by Truck use the TruckModeOptions parameter.
    
    Default Value: Car
    See Also:
    
    TravelMode
  - travelModeAsString
```
public final String travelModeAsString()
```
    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
    
    The TravelMode you specify determines how you specify route preferences:
    - If traveling by Car use the CarModeOptions parameter.
    - If traveling by Truck use the TruckModeOptions parameter.
    Default Value: Car
    
    If the service returns an enum value that is not available in the current SDK version, travelMode will return TravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().
    Returns:
    Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
    
    The TravelMode you specify determines how you specify route preferences:
    
    If traveling by Car use the CarModeOptions parameter.
    
    If traveling by Truck use the TruckModeOptions parameter.
    
    Default Value: Car
    See Also:
    
    TravelMode
  - truckModeOptions
```
public final CalculateRouteTruckModeOptions truckModeOptions()
```
    Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
    
    Requirements: TravelMode must be specified as Truck.
    
    Returns:
    
    Specifies route preferences when traveling by Truck, such as avoiding routes that use ferries or tolls, and truck specifications to consider when choosing an optimal road.
    
    Requirements: TravelMode must be specified as Truck.
  - hasWaypointPositions
```
public final boolean hasWaypointPositions()
```
    For responses, this returns true if the service returned a value for the WaypointPositions 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.
  - waypointPositions
```
public final List<List<Double>> waypointPositions()
```
    Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
    - For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
    If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
    
    Specifying more than 23 waypoints returns a 400 ValidationException error.
    
    If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
    
    Valid Values: [-180 to 180,-90 to 90]
    
    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 hasWaypointPositions() method.
    Returns:
    Specifies an ordered list of up to 23 intermediate positions to include along a route between the departure position and destination position.
    
    For example, from the DeparturePosition [-123.115, 49.285], the route follows the order that the waypoint positions are given [[-122.757, 49.0021],[-122.349, 47.620]]
    
    If you specify a waypoint position that's not located on a road, Amazon Location moves the position to the nearest road.
    
    Specifying more than 23 waypoints returns a 400 ValidationException error.
    
    If Esri is the provider for your route calculator, specifying a route that is longer than 400 km returns a 400 RoutesValidationException error.
    
    Valid Values: [-180 to 180,-90 to 90]
  - toBuilder
```
public CalculateRouteRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CalculateRouteRequest.Builder,CalculateRouteRequest>
    
    Specified by:
    
    toBuilder in class LocationRequest
  - builder
```
public static CalculateRouteRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CalculateRouteRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CalculateRouteRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

calculatorName

carModeOptions

departNow

hasDeparturePosition

departurePosition

departureTime

hasDestinationPosition

destinationPosition

distanceUnit

distanceUnitAsString

includeLegGeometry

travelMode

travelModeAsString

truckModeOptions

hasWaypointPositions

waypointPositions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields