Package software.amazon.awssdk.services.location.model

Class CalculateRouteMatrixRequest

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

      • 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]

      • 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]

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

        Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

        Truck is not available for Grab.

        For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

        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.

        Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

        Truck is not available for Grab.

        For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

        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.

        Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

        Truck is not available for Grab.

        For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

        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.

        Bicycle or Motorcycle are only valid when using Grab as a data provider, and only within Southeast Asia.

        Truck is not available for Grab.

        For more information about using Grab as a data provider, see GrabMaps in the Amazon Location Service Developer Guide.

        Default Value: Car

        See Also:
        TravelMode

      • 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

      • 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

      • 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

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

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

      • key

        public final String key()

        The optional API key to authorize the request.

        Returns:
        The optional API key to authorize the request.

      • 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