Class WaypointOptimizationWaypoint

java.lang.Object
software.amazon.awssdk.services.georoutes.model.WaypointOptimizationWaypoint
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WaypointOptimizationWaypoint.Builder,WaypointOptimizationWaypoint>
@Generated("software.amazon.awssdk:codegen") public final class WaypointOptimizationWaypoint extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WaypointOptimizationWaypoint.Builder,WaypointOptimizationWaypoint>

Waypoint between the Origin and Destination.

See Also:

  • Method Details

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

    • toBuilder

      public WaypointOptimizationWaypoint.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WaypointOptimizationWaypoint.Builder,WaypointOptimizationWaypoint>
      Returns:
      a builder for type T

    • builder

      public static WaypointOptimizationWaypoint.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WaypointOptimizationWaypoint.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.