Class CalculateRouteMatrixSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<CalculateRouteMatrixSummary.Builder,
CalculateRouteMatrixSummary>
A summary of the calculated route matrix.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The data provider of traffic and road network data used to calculate the routes.final DistanceUnit
The unit of measurement for route distances.final String
The unit of measurement for route distances.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The count of error results in the route matrix.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final Integer
The count of cells in the route matrix.static Class
<? extends CalculateRouteMatrixSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
-
-
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 returnDistanceUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdistanceUnitAsString()
.- Returns:
- The unit of measurement for route distances.
- See Also:
-
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 returnDistanceUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdistanceUnitAsString()
.- Returns:
- The unit of measurement for route distances.
- See Also:
-
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.
-
routeCount
The count of cells in the route matrix. Equal to the number of
DeparturePositions
multiplied by the number ofDestinationPositions
.- Returns:
- The count of cells in the route matrix. Equal to the number of
DeparturePositions
multiplied by the number ofDestinationPositions
.
-
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 interfaceToCopyableBuilder<CalculateRouteMatrixSummary.Builder,
CalculateRouteMatrixSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-