Package software.amazon.awssdk.services.location.model

Class CalculateRouteResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.CalculateRouteResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateRouteResponse.Builder,CalculateRouteResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CalculateRouteResponse
extends LocationResponse
implements ToCopyableBuilder<CalculateRouteResponse.Builder,CalculateRouteResponse>

Returns the result of the route calculation. Metadata includes legs and route summary.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRouteResponse.Builder

Method Summary

Modifier and Type	Method	Description
static CalculateRouteResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLegs()	For responses, this returns true if the service returned a value for the Legs property.
List<Leg>	legs()	Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps.
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteResponse.Builder>	serializableBuilderClass()
CalculateRouteSummary	summary()	Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.
CalculateRouteResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasLegs

public final boolean hasLegs()

For responses, this returns true if the service returned a value for the Legs 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.

legs

public final List<Leg> legs()

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.

• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

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

Returns:

Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds , Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

• The StartPosition is the departure position.

• The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

• Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.

• Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

summary

public final CalculateRouteSummary summary()

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

Returns:

Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.

toBuilder

public CalculateRouteResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteResponse.Builder,CalculateRouteResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CalculateRouteResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CalculateRouteResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo