CalculateRouteSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.location.model.CalculateRouteSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CalculateRouteSummary.Builder,CalculateRouteSummary>

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

A summary of the calculated route.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CalculateRouteSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CalculateRouteSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CalculateRouteSummary.Builder`	`builder()`
`String`	`dataSource()` The data provider of traffic and road network data used to calculate the route.
`Double`	`distance()` The total distance covered by the route.
`DistanceUnit`	`distanceUnit()` The unit of measurement for the distance.
`String`	`distanceUnitAsString()` The unit of measurement for the distance.
`Double`	`durationSeconds()` The total travel time for the route measured in seconds.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasRouteBBox()` Returns true if the RouteBBox property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<Double>`	`routeBBox()` Specifies a geographical box surrounding a route.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CalculateRouteSummary.Builder>`	`serializableBuilderClass()`
`CalculateRouteSummary.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 route. Indicates one of the available providers:
    - Esri
    - 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 route. Indicates one of the available providers:
    
    Esri
    
    Here
    
    For more information about data providers, see Amazon Location Service data providers.
  - distance
```
public final Double distance()
```
    The total distance covered by the route. The sum of the distance travelled between every stop on the route.
    
    The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.
    
    Returns:
    
    The total distance covered by the route. The sum of the distance travelled between every stop on the route.
    
    The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.
  - distanceUnit
```
public final DistanceUnit distanceUnit()
```
    The unit of measurement for the distance.
    
    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 the distance.
    
    See Also:
    
    DistanceUnit
  - distanceUnitAsString
```
public final String distanceUnitAsString()
```
    The unit of measurement for the distance.
    
    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 the distance.
    
    See Also:
    
    DistanceUnit
  - durationSeconds
```
public final Double durationSeconds()
```
    The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
    
    Returns:
    
    The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.
  - hasRouteBBox
```
public final boolean hasRouteBBox()
```
    Returns true if the RouteBBox property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - routeBBox
```
public final List<Double> routeBBox()
```
    Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].
    
    The first 2 bbox parameters describe the lower southwest corner:
    - The first bbox position is the X coordinate or longitude of the lower southwest corner.
    - The second bbox position is the Y coordinate or latitude of the lower southwest corner.
    The next 2 bbox parameters describe the upper northeast corner:
    - The third bbox position is the X coordinate, or longitude of the upper northeast corner.
    - The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRouteBBox() to see if a value was sent in this field.
    Returns:
    Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].
    
    The first 2 bbox parameters describe the lower southwest corner:
    
    The first bbox position is the X coordinate or longitude of the lower southwest corner.
    
    The second bbox position is the Y coordinate or latitude of the lower southwest corner.
    
    The next 2 bbox parameters describe the upper northeast corner:
    
    The third bbox position is the X coordinate, or longitude of the upper northeast corner.
    
    The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.
  - toBuilder
```
public CalculateRouteSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CalculateRouteSummary.Builder,CalculateRouteSummary>
  - builder
```
public static CalculateRouteSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CalculateRouteSummary.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

Class CalculateRouteSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dataSource

distance

distanceUnit

distanceUnitAsString

durationSeconds

hasRouteBBox

routeBBox

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields