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

Class CalculateRouteSummary

java.lang.Object

software.amazon.awssdk.services.location.model.CalculateRouteSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CalculateRouteSummary.Builder,CalculateRouteSummary>

@Generated("software.amazon.awssdk:codegen")
public final class CalculateRouteSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CalculateRouteSummary.Builder,CalculateRouteSummary>

A summary of the calculated route.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRouteSummary.Builder

Method Summary

Modifier and Type	Method	Description
static CalculateRouteSummary.Builder	builder()
String	dataSource()	The data provider of traffic and road network data used to calculate the route.
Double	distance()	The total distance covered by the route.
DistanceUnit	distanceUnit()	The unit of measurement for route distances.
String	distanceUnitAsString()	The unit of measurement for route distances.
Double	durationSeconds()	The total travel time for the route measured in seconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRouteBBox()	For responses, this returns true if the service returned a value for the RouteBBox property.
List<Double>	routeBBox()	Specifies a geographical box surrounding a route.
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteSummary.Builder>	serializableBuilderClass()
CalculateRouteSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

dataSource

public final String dataSource()

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

Returns:

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

• Esri

• Grab

• Here

For more information about data providers, see Amazon Location Service data providers.

distance

public final Double distance()

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

Returns:

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

If Esri is the data source for the route calculator, the route distance can’t be greater than 400 km. If the route exceeds 400 km, the response is a 400 RoutesValidationException error.

distanceUnit

public final DistanceUnit distanceUnit()

The unit of measurement for route distances.

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

Returns:

The unit of measurement for route distances.

See Also:

DistanceUnit

distanceUnitAsString

public final String distanceUnitAsString()

The unit of measurement for route distances.

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

Returns:

The unit of measurement for route distances.

See Also:

DistanceUnit

durationSeconds

public final Double durationSeconds()

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

Returns:

The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.

hasRouteBBox

public final boolean hasRouteBBox()

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

routeBBox

public final List<Double> routeBBox()

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

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

Returns:

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

• The first bbox position is the X coordinate or longitude of the lower southwest corner.

• The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

• The third bbox position is the X coordinate, or longitude of the upper northeast corner.

• The fourth bbox position is the Y coordinate, or latitude of the upper northeast corner.

toBuilder

public CalculateRouteSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteSummary.Builder,CalculateRouteSummary>

builder

public static CalculateRouteSummary.Builder builder()

serializableBuilderClass

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