Class RouteLeg

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

A leg is a section of a route from one waypoint to the next. A leg could be of type Vehicle, Pedestrian or Ferry. Legs of different types could occur together within a single route. For example, a car employing the use of a Ferry will contain Vehicle legs corresponding to journey on land, and Ferry legs corresponding to the journey via Ferry.

See Also:

  • Method Details

    • ferryLegDetails

      public final RouteFerryLegDetails ferryLegDetails()

      FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

      Returns:
      FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific

    • geometry

      public final RouteLegGeometry geometry()

      Geometry of the area to be avoided.

      Returns:
      Geometry of the area to be avoided.

    • language

      public final String language()

      List of languages for instructions within steps in the response.

      Returns:
      List of languages for instructions within steps in the response.

    • pedestrianLegDetails

      public final RoutePedestrianLegDetails pedestrianLegDetails()

      Details related to the pedestrian leg.

      Returns:
      Details related to the pedestrian leg.

    • travelMode

      public final RouteLegTravelMode travelMode()

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      If the service returns an enum value that is not available in the current SDK version, travelMode will return RouteLegTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

      Returns:
      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      See Also:

    • travelModeAsString

      public final String travelModeAsString()

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      If the service returns an enum value that is not available in the current SDK version, travelMode will return RouteLegTravelMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from travelModeAsString().

      Returns:
      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      See Also:

    • type

      public final RouteLegType type()

      Type of the leg.

      If the service returns an enum value that is not available in the current SDK version, type will return RouteLegType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Type of the leg.
      See Also:

    • typeAsString

      public final String typeAsString()

      Type of the leg.

      If the service returns an enum value that is not available in the current SDK version, type will return RouteLegType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      Type of the leg.
      See Also:

    • vehicleLegDetails

      public final RouteVehicleLegDetails vehicleLegDetails()

      Details related to the vehicle leg.

      Returns:
      Details related to the vehicle leg.

    • toBuilder

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

    • builder

      public static RouteLeg.Builder builder()

    • serializableBuilderClass

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