Class RouteVehicleLegDetails
- java.lang.Object
-
- software.amazon.awssdk.services.georoutes.model.RouteVehicleLegDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RouteVehicleLegDetails.Builder,RouteVehicleLegDetails>
@Generated("software.amazon.awssdk:codegen") public final class RouteVehicleLegDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteVehicleLegDetails.Builder,RouteVehicleLegDetails>
Steps of a leg that correspond to the travel portion of the leg.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRouteVehicleLegDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description RouteVehicleArrivalarrival()Details corresponding to the arrival for the leg.static RouteVehicleLegDetails.Builderbuilder()RouteVehicleDeparturedeparture()Details corresponding to the departure for the leg.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasIncidents()For responses, this returns true if the service returned a value for the Incidents property.booleanhasNotices()For responses, this returns true if the service returned a value for the Notices property.booleanhasPassThroughWaypoints()For responses, this returns true if the service returned a value for the PassThroughWaypoints property.booleanhasSpans()For responses, this returns true if the service returned a value for the Spans property.booleanhasTolls()For responses, this returns true if the service returned a value for the Tolls property.booleanhasTollSystems()For responses, this returns true if the service returned a value for the TollSystems property.booleanhasTravelSteps()For responses, this returns true if the service returned a value for the TravelSteps property.booleanhasTruckRoadTypes()For responses, this returns true if the service returned a value for the TruckRoadTypes property.booleanhasZones()For responses, this returns true if the service returned a value for the Zones property.List<RouteVehicleIncident>incidents()Incidents corresponding to this leg of the route.List<RouteVehicleNotice>notices()Notices are additional information returned that indicate issues that occurred during route calculation.List<RoutePassThroughWaypoint>passThroughWaypoints()Waypoints that were passed through during the leg.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RouteVehicleLegDetails.Builder>serializableBuilderClass()List<RouteVehicleSpan>spans()Spans that were computed for the requested SpanAdditionalFeatures.RouteVehicleSummarysummary()Summarized details of the leg.RouteVehicleLegDetails.BuildertoBuilder()List<RouteToll>tolls()Toll related options.List<RouteTollSystem>tollSystems()Toll systems are authorities that collect payments for the toll.StringtoString()Returns a string representation of this object.List<RouteVehicleTravelStep>travelSteps()Steps of a leg that must be performed before the travel portion of the leg.List<String>truckRoadTypes()Truck road type identifiers.List<RouteZone>zones()Zones corresponding to this leg of the route.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arrival
public final RouteVehicleArrival arrival()
Details corresponding to the arrival for the leg.
- Returns:
- Details corresponding to the arrival for the leg.
-
departure
public final RouteVehicleDeparture departure()
Details corresponding to the departure for the leg.
- Returns:
- Details corresponding to the departure for the leg.
-
hasIncidents
public final boolean hasIncidents()
For responses, this returns true if the service returned a value for the Incidents 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.
-
incidents
public final List<RouteVehicleIncident> incidents()
Incidents corresponding to this leg of the route.
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
hasIncidents()method.- Returns:
- Incidents corresponding to this leg of the route.
-
hasNotices
public final boolean hasNotices()
For responses, this returns true if the service returned a value for the Notices 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.
-
notices
public final List<RouteVehicleNotice> notices()
Notices are additional information returned that indicate issues that occurred during route calculation.
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
hasNotices()method.- Returns:
- Notices are additional information returned that indicate issues that occurred during route calculation.
-
hasPassThroughWaypoints
public final boolean hasPassThroughWaypoints()
For responses, this returns true if the service returned a value for the PassThroughWaypoints 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.
-
passThroughWaypoints
public final List<RoutePassThroughWaypoint> passThroughWaypoints()
Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
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
hasPassThroughWaypoints()method.- Returns:
- Waypoints that were passed through during the leg. This includes the waypoints that were configured with the PassThrough option.
-
hasSpans
public final boolean hasSpans()
For responses, this returns true if the service returned a value for the Spans 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.
-
spans
public final List<RouteVehicleSpan> spans()
Spans that were computed for the requested SpanAdditionalFeatures.
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
hasSpans()method.- Returns:
- Spans that were computed for the requested SpanAdditionalFeatures.
-
summary
public final RouteVehicleSummary summary()
Summarized details of the leg.
- Returns:
- Summarized details of the leg.
-
hasTolls
public final boolean hasTolls()
For responses, this returns true if the service returned a value for the Tolls 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.
-
tolls
public final List<RouteToll> tolls()
Toll related options.
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
hasTolls()method.- Returns:
- Toll related options.
-
hasTollSystems
public final boolean hasTollSystems()
For responses, this returns true if the service returned a value for the TollSystems 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.
-
tollSystems
public final List<RouteTollSystem> tollSystems()
Toll systems are authorities that collect payments for the toll.
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
hasTollSystems()method.- Returns:
- Toll systems are authorities that collect payments for the toll.
-
hasTravelSteps
public final boolean hasTravelSteps()
For responses, this returns true if the service returned a value for the TravelSteps 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.
-
travelSteps
public final List<RouteVehicleTravelStep> travelSteps()
Steps of a leg that must be performed before the travel portion of the leg.
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
hasTravelSteps()method.- Returns:
- Steps of a leg that must be performed before the travel portion of the leg.
-
hasTruckRoadTypes
public final boolean hasTruckRoadTypes()
For responses, this returns true if the service returned a value for the TruckRoadTypes 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.
-
truckRoadTypes
public final List<String> truckRoadTypes()
Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.There are currently no other supported values as of 26th April 2024.
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
hasTruckRoadTypes()method.- Returns:
- Truck road type identifiers.
BK1throughBK4apply only to Sweden.A2,A4,B2,B4,C,D,ET2,ET4apply only to Mexico.There are currently no other supported values as of 26th April 2024.
-
hasZones
public final boolean hasZones()
For responses, this returns true if the service returned a value for the Zones 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.
-
zones
public final List<RouteZone> zones()
Zones corresponding to this leg of the route.
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
hasZones()method.- Returns:
- Zones corresponding to this leg of the route.
-
toBuilder
public RouteVehicleLegDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RouteVehicleLegDetails.Builder,RouteVehicleLegDetails>
-
builder
public static RouteVehicleLegDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends RouteVehicleLegDetails.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-