Class WaypointOptimizationWaypoint

    • Method Detail

      • accessHours

        public final WaypointOptimizationAccessHours accessHours()

        Access hours corresponding to when a waypoint can be visited.

        Returns:
        Access hours corresponding to when a waypoint can be visited.
      • appointmentTime

        public final String appointmentTime()

        Appointment time at the waypoint.

        Returns:
        Appointment time at the waypoint.
      • hasBefore

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

        public final List<Integer> before()

        Constraint defining what waypoints are to be visited after this waypoint.

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

        Returns:
        Constraint defining what waypoints are to be visited after this waypoint.
      • heading

        public final Double heading()

        GPS Heading at the position.

        Returns:
        GPS Heading at the position.
      • id

        public final String id()

        The waypoint Id.

        Returns:
        The waypoint Id.
      • hasPosition

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

        public final List<Double> position()

        Position defined as [longitude, latitude].

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

        Returns:
        Position defined as [longitude, latitude].
      • serviceDuration

        public final Long serviceDuration()

        Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.

        Unit: seconds

        Returns:
        Service time spent at the waypoint. At an appointment, the service time should be the appointment duration.

        Unit: seconds

      • sideOfStreet

        public final WaypointOptimizationSideOfStreetOptions sideOfStreet()

        Options to configure matching the provided position to a side of the street.

        Returns:
        Options to configure matching the provided position to a side of the street.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)