Package software.amazon.awssdk.services.georoutes.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteLeg.Builder

Method Summary

Modifier and Type	Method	Description
static RouteLeg.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
RouteFerryLegDetails	ferryLegDetails()	FerryLegDetails is populated when the Leg type is Ferry, and provides additional information that is specific
RouteLegGeometry	geometry()	Geometry of the area to be avoided.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	language()	List of languages for instructions within steps in the response.
RoutePedestrianLegDetails	pedestrianLegDetails()	Details related to the pedestrian leg.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteLeg.Builder>	serializableBuilderClass()
RouteLeg.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RouteLegTravelMode	travelMode()	Specifies the mode of transport when calculating a route.
String	travelModeAsString()	Specifies the mode of transport when calculating a route.
RouteLegType	type()	Type of the leg.
String	typeAsString()	Type of the leg.
RouteVehicleLegDetails	vehicleLegDetails()	Details related to the vehicle 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

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:

RouteLegTravelMode

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:

RouteLegTravelMode

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:

RouteLegType

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:

RouteLegType

vehicleLegDetails

public final RouteVehicleLegDetails vehicleLegDetails()

Details related to the vehicle leg.

Returns:

Details related to the vehicle leg.

toBuilder

public RouteLeg.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteLeg.Builder,RouteLeg>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo