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

Class CalculateRouteMatrixResponse

    • Method Detail

      • hasRouteMatrix

        public final boolean hasRouteMatrix()
        For responses, this returns true if the service returned a value for the RouteMatrix 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.

      • routeMatrix

        public final List<List<RouteMatrixEntry>> routeMatrix()

        The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

        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 hasRouteMatrix() method.

        Returns:
        The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

      • hasSnappedDeparturePositions

        public final boolean hasSnappedDeparturePositions()
        For responses, this returns true if the service returned a value for the SnappedDeparturePositions 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.

      • snappedDeparturePositions

        public final List<List<Double>> snappedDeparturePositions()

        For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

        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 hasSnappedDeparturePositions() method.

        Returns:
        For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

      • hasSnappedDestinationPositions

        public final boolean hasSnappedDestinationPositions()
        For responses, this returns true if the service returned a value for the SnappedDestinationPositions 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.

      • snappedDestinationPositions

        public final List<List<Double>> snappedDestinationPositions()

        The list of destination positions for the route matrix used for calculation of the RouteMatrix.

        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 hasSnappedDestinationPositions() method.

        Returns:
        The list of destination positions for the route matrix used for calculation of the RouteMatrix.

      • summary

        public final CalculateRouteMatrixSummary summary()

        Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

        Returns:
        Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

      • 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