Class WaypointOptimizationWaypoint
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WaypointOptimizationWaypoint.Builder,
WaypointOptimizationWaypoint>
Waypoint between the Origin and Destination.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionAccess hours corresponding to when a waypoint can be visited.final String
Appointment time at the waypoint.before()
Constraint defining what waypoints are to be visited after this waypoint.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Before property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Position property.final Double
heading()
GPS Heading at the position.final String
id()
The waypoint Id.position()
Position defined as[longitude, latitude]
.static Class
<? extends WaypointOptimizationWaypoint.Builder> final Long
Service time spent at the waypoint.Options to configure matching the provided position to a side of the street.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessHours
Access hours corresponding to when a waypoint can be visited.
- Returns:
- Access hours corresponding to when a waypoint can be visited.
-
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 theisEmpty()
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
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
-
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 theisEmpty()
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
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
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
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
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 interfaceToCopyableBuilder<WaypointOptimizationWaypoint.Builder,
WaypointOptimizationWaypoint> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-