Class OptimizeWaypointsResponse

    • Method Detail

      • hasConnections

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

        public final List<WaypointOptimizationConnection> connections()

        Details about the connection from one waypoint to the next, within the optimized sequence.

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

        Returns:
        Details about the connection from one waypoint to the next, within the optimized sequence.
      • distance

        public final Long distance()

        Overall distance to travel the whole sequence.

        Returns:
        Overall distance to travel the whole sequence.
      • duration

        public final Long duration()

        Overall duration to travel the whole sequence.

        Unit: seconds

        Returns:
        Overall duration to travel the whole sequence.

        Unit: seconds

      • hasImpedingWaypoints

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

        public final List<WaypointOptimizationImpedingWaypoint> impedingWaypoints()

        Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.

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

        Returns:
        Returns waypoints that caused the optimization problem to fail, and the constraints that were unsatisfied leading to the failure.
      • hasOptimizedWaypoints

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

        public final List<WaypointOptimizationOptimizedWaypoint> optimizedWaypoints()

        Waypoints in the order of the optimized sequence.

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

        Returns:
        Waypoints in the order of the optimized sequence.
      • pricingBucket

        public final String pricingBucket()

        The pricing bucket for which the query is charged at.

        Returns:
        The pricing bucket for which the query is charged at.
      • 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