Class RouteFerryLegDetails
- java.lang.Object
-
- software.amazon.awssdk.services.georoutes.model.RouteFerryLegDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RouteFerryLegDetails.Builder,RouteFerryLegDetails>
@Generated("software.amazon.awssdk:codegen") public final class RouteFerryLegDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteFerryLegDetails.Builder,RouteFerryLegDetails>
FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRouteFerryLegDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<RouteFerryAfterTravelStep>afterTravelSteps()Steps of a leg that must be performed after the travel portion of the leg.RouteFerryArrivalarrival()Details corresponding to the arrival for the leg.List<RouteFerryBeforeTravelStep>beforeTravelSteps()Steps of a leg that must be performed before the travel portion of the leg.static RouteFerryLegDetails.Builderbuilder()RouteFerryDeparturedeparture()Details corresponding to the departure for the leg.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAfterTravelSteps()For responses, this returns true if the service returned a value for the AfterTravelSteps property.booleanhasBeforeTravelSteps()For responses, this returns true if the service returned a value for the BeforeTravelSteps property.inthashCode()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.booleanhasTravelSteps()For responses, this returns true if the service returned a value for the TravelSteps property.List<RouteFerryNotice>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.StringrouteName()Route name of the ferry line.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RouteFerryLegDetails.Builder>serializableBuilderClass()List<RouteFerrySpan>spans()Spans that were computed for the requested SpanAdditionalFeatures.RouteFerrySummarysummary()Summarized details of the leg.RouteFerryLegDetails.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<RouteFerryTravelStep>travelSteps()Steps of a leg that must be performed before the travel portion of the leg.-
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
-
hasAfterTravelSteps
public final boolean hasAfterTravelSteps()
For responses, this returns true if the service returned a value for the AfterTravelSteps 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.
-
afterTravelSteps
public final List<RouteFerryAfterTravelStep> afterTravelSteps()
Steps of a leg that must be performed after 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
hasAfterTravelSteps()method.- Returns:
- Steps of a leg that must be performed after the travel portion of the leg.
-
arrival
public final RouteFerryArrival arrival()
Details corresponding to the arrival for the leg.
- Returns:
- Details corresponding to the arrival for the leg.
-
hasBeforeTravelSteps
public final boolean hasBeforeTravelSteps()
For responses, this returns true if the service returned a value for the BeforeTravelSteps 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.
-
beforeTravelSteps
public final List<RouteFerryBeforeTravelStep> beforeTravelSteps()
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
hasBeforeTravelSteps()method.- Returns:
- Steps of a leg that must be performed before the travel portion of the leg.
-
departure
public final RouteFerryDeparture departure()
Details corresponding to the departure for the leg.
- Returns:
- Details corresponding to the departure for the leg.
-
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<RouteFerryNotice> 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.
-
routeName
public final String routeName()
Route name of the ferry line.
- Returns:
- Route name of the ferry line.
-
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<RouteFerrySpan> 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 RouteFerrySummary summary()
Summarized details of the leg.
- Returns:
- Summarized details of the leg.
-
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<RouteFerryTravelStep> 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.
-
toBuilder
public RouteFerryLegDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RouteFerryLegDetails.Builder,RouteFerryLegDetails>
-
builder
public static RouteFerryLegDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends RouteFerryLegDetails.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
-
-