Class CalculateRouteMatrixResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,
CalculateRouteMatrixResponse>
Returns the result of the route matrix calculation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RouteMatrix property.final boolean
For responses, this returns true if the service returned a value for the SnappedDeparturePositions property.final boolean
For responses, this returns true if the service returned a value for the SnappedDestinationPositions property.final List
<List<RouteMatrixEntry>> The calculated route matrix containing the results for all pairs ofDeparturePositions
toDestinationPositions
.static Class
<? extends CalculateRouteMatrixResponse.Builder> For routes calculated using an Esri route calculator resource, departure positions are snapped to the closest road.The list of destination positions for the route matrix used for calculation of theRouteMatrix
.summary()
Contains information about the route matrix,DataSource
,DistanceUnit
,RouteCount
andErrorCount
.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 class software.amazon.awssdk.services.location.model.LocationResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
The calculated route matrix containing the results for all pairs of
DeparturePositions
toDestinationPositions
. Each row corresponds to one entry inDeparturePositions
. Each entry in the row corresponds to the route from that entry inDeparturePositions
to an entry inDestinationPositions
.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
toDestinationPositions
. Each row corresponds to one entry inDeparturePositions
. Each entry in the row corresponds to the route from that entry inDeparturePositions
to an entry inDestinationPositions
.
-
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 theisEmpty()
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
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 theisEmpty()
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
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
Contains information about the route matrix,
DataSource
,DistanceUnit
,RouteCount
andErrorCount
.- Returns:
- Contains information about the route matrix,
DataSource
,DistanceUnit
,RouteCount
andErrorCount
.
-
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<CalculateRouteMatrixResponse.Builder,
CalculateRouteMatrixResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-