CalculateRouteMatrixRequest (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.CalculateRouteMatrixRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CalculateRouteMatrixRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CalculateRouteMatrixRequest.Builder`	`builder()`
`String`	`calculatorName()` The name of the route calculator resource that you want to use to calculate the route matrix.
`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<List<Double>>`	`departurePositions()` The list of departure (origin) positions for the route matrix.
`Instant`	`departureTime()` Specifies the desired time of departure.
`List<List<Double>>`	`destinationPositions()` The list of destination positions for the route matrix.
`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`	`hasDeparturePositions()` For responses, this returns true if the service returned a value for the DeparturePositions property.
`boolean`	`hasDestinationPositions()` For responses, this returns true if the service returned a value for the DestinationPositions property.
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CalculateRouteMatrixRequest.Builder>`	`serializableBuilderClass()`
`CalculateRouteMatrixRequest.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.

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 the route matrix.
    
    Returns:
    
    The name of the route calculator resource that you want to use to calculate the route matrix.
  - 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 the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Sets the time of departure as the current time. Uses the current time to calculate the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
    
    Default Value: false
    
    Valid Values: false | true
  - hasDeparturePositions
```
public final boolean hasDeparturePositions()
```
    For responses, this returns true if the service returned a value for the DeparturePositions 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.
  - departurePositions
```
public final List<List<Double>> departurePositions()
```
    The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].
    
    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
    
    For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.
    
    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 hasDeparturePositions() method.
    
    Returns:
    
    The list of departure (origin) positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-123.115, 49.285].
    
    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
    
    For route calculators that use Esri as the data provider, if you specify a departure that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDeparturePositions.
    
    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 the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
    
    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 the route matrix. You can't set both DepartureTime and DepartNow. If neither is set, the best time of day to travel with the best traffic conditions is used to calculate the route matrix.
    
    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
  - hasDestinationPositions
```
public final boolean hasDestinationPositions()
```
    For responses, this returns true if the service returned a value for the DestinationPositions 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.
  - destinationPositions
```
public final List<List<Double>> destinationPositions()
```
    The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]
    
    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
    
    For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.
    
    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 hasDestinationPositions() method.
    
    Returns:
    
    The list of destination positions for the route matrix. An array of points, each of which is itself a 2-value array defined in WGS 84 format: [longitude, latitude]. For example, [-122.339, 47.615]
    
    Depending on the data provider selected in the route calculator resource there may be additional restrictions on the inputs you can choose. See Position restrictions in the Amazon Location Service Developer Guide.
    
    For route calculators that use Esri as the data provider, if you specify a destination that's not located on a road, Amazon Location moves the position to the nearest road. The snapped value is available in the result in SnappedDestinationPositions.
    
    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
  - 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 also 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 also 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 also 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 also 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.
  - toBuilder
```
public CalculateRouteMatrixRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CalculateRouteMatrixRequest.Builder,CalculateRouteMatrixRequest>
    
    Specified by:
    
    toBuilder in class LocationRequest
  - builder
```
public static CalculateRouteMatrixRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CalculateRouteMatrixRequest.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 CalculateRouteMatrixRequest

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

hasDeparturePositions

departurePositions

departureTime

hasDestinationPositions

destinationPositions

distanceUnit

distanceUnitAsString

travelMode

travelModeAsString

truckModeOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields