Class CalculateRouteResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CalculateRouteResponse.Builder,
CalculateRouteResponse>
Returns the result of the route calculation. Metadata includes legs and route summary.
-
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
hasLegs()
For responses, this returns true if the service returned a value for the Legs property.legs()
Contains details about each path between a pair of positions included along a route such as:StartPosition
,EndPosition
,Distance
,DurationSeconds
,Geometry
, andSteps
.static Class
<? extends CalculateRouteResponse.Builder> final CalculateRouteSummary
summary()
Contains information about the whole route, such as:RouteBBox
,DataSource
,Distance
,DistanceUnit
, andDurationSeconds
.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
-
hasLegs
public final boolean hasLegs()For responses, this returns true if the service returned a value for the Legs 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. -
legs
Contains details about each path between a pair of positions included along a route such as:
StartPosition
,EndPosition
,Distance
,DurationSeconds
,Geometry
, andSteps
. The number of legs returned corresponds to one fewer than the total number of positions in the request.For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
-
The
StartPosition
is the departure position. -
The
EndPosition
is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
-
Leg 1: The
StartPosition
is the departure position . TheEndPosition
is the waypoint positon. -
Leg 2: The
StartPosition
is the waypoint position. TheEndPosition
is the destination position.
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
hasLegs()
method.- Returns:
- Contains details about each path between a pair of positions included along a route such as:
StartPosition
,EndPosition
,Distance
,DurationSeconds
,Geometry
, andSteps
. The number of legs returned corresponds to one fewer than the total number of positions in the request.For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:
-
The
StartPosition
is the departure position. -
The
EndPosition
is the destination position.
A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:
-
Leg 1: The
StartPosition
is the departure position . TheEndPosition
is the waypoint positon. -
Leg 2: The
StartPosition
is the waypoint position. TheEndPosition
is the destination position.
-
-
-
summary
Contains information about the whole route, such as:
RouteBBox
,DataSource
,Distance
,DistanceUnit
, andDurationSeconds
.- Returns:
- Contains information about the whole route, such as:
RouteBBox
,DataSource
,Distance
,DistanceUnit
, andDurationSeconds
.
-
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<CalculateRouteResponse.Builder,
CalculateRouteResponse> - 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
-