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

Class CalculateRouteMatrixSummary

java.lang.Object

software.amazon.awssdk.services.location.model.CalculateRouteMatrixSummary

All Implemented Interfaces:

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

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

A summary of the calculated route matrix.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateRouteMatrixSummary.Builder

Method Summary

Modifier and Type	Method	Description
static CalculateRouteMatrixSummary.Builder	builder()
String	dataSource()	The data provider of traffic and road network data used to calculate the routes.
DistanceUnit	distanceUnit()	The unit of measurement for route distances.
String	distanceUnitAsString()	The unit of measurement for route distances.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	errorCount()	The count of error results in the route matrix.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	routeCount()	The count of cells in the route matrix.
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteMatrixSummary.Builder>	serializableBuilderClass()
CalculateRouteMatrixSummary.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 routes. 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 routes. Indicates one of the available providers:

• Esri

• Grab

• Here

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

routeCount

public final Integer routeCount()

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

Returns:

The count of cells in the route matrix. Equal to the number of DeparturePositions multiplied by the number of DestinationPositions.

errorCount

public final Integer errorCount()

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

Returns:

The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

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

toBuilder

public CalculateRouteMatrixSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteMatrixSummary.Builder,CalculateRouteMatrixSummary>

builder

public static CalculateRouteMatrixSummary.Builder builder()

serializableBuilderClass

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