software.amazon.awssdk.services.location.model

Class CalculateRouteMatrixResponse

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.CalculateRouteMatrixResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

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

Returns the result of the route matrix calculation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CalculateRouteMatrixResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CalculateRouteMatrixResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRouteMatrix() For responses, this returns true if the service returned a value for the RouteMatrix property.
boolean	hasSnappedDeparturePositions() For responses, this returns true if the service returned a value for the SnappedDeparturePositions property.
boolean	hasSnappedDestinationPositions() For responses, this returns true if the service returned a value for the SnappedDestinationPositions property.
List<List<RouteMatrixEntry>>	routeMatrix() The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions.
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateRouteMatrixResponse.Builder>	serializableBuilderClass()
List<List<Double>>	snappedDeparturePositions() For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road.
List<List<Double>>	snappedDestinationPositions() The list of destination positions for the route matrix used for calculation of the RouteMatrix.
CalculateRouteMatrixSummary	summary() Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.
CalculateRouteMatrixResponse.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

hasRouteMatrix

public final boolean hasRouteMatrix()

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

routeMatrix

public final List<List<RouteMatrixEntry>> routeMatrix()

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

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

Returns:

The calculated route matrix containing the results for all pairs of DeparturePositions to DestinationPositions. Each row corresponds to one entry in DeparturePositions. Each entry in the row corresponds to the route from that entry in DeparturePositions to an entry in DestinationPositions.

hasSnappedDeparturePositions

public final boolean hasSnappedDeparturePositions()

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

snappedDeparturePositions

public final List<List<Double>> snappedDeparturePositions()

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

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

Returns:

For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road. For Esri route calculator resources, this returns the list of departure/origin positions used for calculation of the RouteMatrix.

hasSnappedDestinationPositions

public final boolean hasSnappedDestinationPositions()

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

snappedDestinationPositions

public final List<List<Double>> snappedDestinationPositions()

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

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

Returns:

The list of destination positions for the route matrix used for calculation of the RouteMatrix.

summary

public final CalculateRouteMatrixSummary summary()

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

Returns:

Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

toBuilder

public CalculateRouteMatrixResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CalculateRouteMatrixResponse.Builder builder()

serializableBuilderClass

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