Class RouteTransitLegDetails

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

Populated when the Leg type is Transit, and provides additional information that is specific to public transit travel.

See Also:

  • Method Details

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

    • afterTravelSteps

      public final List<RouteTransitAfterTravelStep> 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.

    • agency

      public final RouteTransitAgency agency()

      Details about the transit agency.

      Returns:
      Details about the transit agency.

    • arrival

      public final RouteTransitArrival arrival()

      Details corresponding to the arrival for the leg.

      Returns:
      Details corresponding to the arrival for the leg.

    • hasAttributions

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

    • attributions

      public final List<RouteAttribution> attributions()

      List of required attributions to display.

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

      Returns:
      List of required attributions to display.

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

    • beforeTravelSteps

      public final List<RouteTransitBeforeTravelStep> 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.

    • hasBookingWebLinks

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

    • bookingWebLinks

      public final List<RouteWebLink> bookingWebLinks()

      Web links to external ticket booking services for the transit.

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

      Returns:
      Web links to external ticket booking services for the transit.

    • departure

      public final RouteTransitDeparture 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 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.

    • incidents

      public final List<RouteTransitIncident> incidents()

      Incidents affecting this leg of the transit 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 affecting this leg of the transit route.

    • hasIntermediateStops

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

    • intermediateStops

      public final List<RouteTransitIntermediateStop> intermediateStops()

      Intermediate stops between departure and destination of the transit 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 hasIntermediateStops() method.

      Returns:
      Intermediate stops between departure and destination of the transit route.

    • hasNextDepartures

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

    • nextDepartures

      public final List<RouteTransitNextDeparture> nextDepartures()

      List of next departures that cover the same section 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 hasNextDepartures() method.

      Returns:
      List of next departures that cover the same section 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 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.

    • notices

      public final List<RouteTransitNotice> notices()

      List of notices 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:
      List of notices 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 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.

    • 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. Not populated when the TravelMode is Transit or Intermodal.

      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. Not populated when the TravelMode is Transit or Intermodal.

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

    • spans

      public final List<RouteTransitSpan> spans()

      Spans that were computed for the requested SpanAdditionalFeatures. Not populated when the TravelMode is Transit or Intermodal.

      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. Not populated when the TravelMode is Transit or Intermodal.

    • summary

      public final RouteTransitSummary summary()

      Summary of the transit leg.

      Returns:
      Summary of the transit leg.

    • transport

      public final RouteTransitTransportModeDetails transport()

      Transport mode details for the transit leg.

      Returns:
      Transport mode details for the transit 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 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.

    • travelSteps

      public final List<RouteTransitTravelStep> travelSteps()

      Steps of a leg that must be performed during 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 during the travel portion of the leg.

    • toBuilder

      public RouteTransitLegDetails.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<RouteTransitLegDetails.Builder,RouteTransitLegDetails>
      Returns:
      a builder for type T

    • builder

      public static RouteTransitLegDetails.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RouteTransitLegDetails.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.