com.amazonaws.services.location.model.CalculateRouteResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.location.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Returns the result of the route calculation. Metadata includes legs and route summary.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CalculateRouteResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the waypoint
* positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination
* position.
*
*
*
*/
private java.util.List legs;
/**
*
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*
*/
private CalculateRouteSummary summary;
/**
*
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the waypoint
* positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination
* position.
*
*
*
*
* @return Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds
* , Geometry, and Steps. 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 . The EndPosition is the
* waypoint positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the
* destination position.
*
*
*/
public java.util.List getLegs() {
return legs;
}
/**
*
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the waypoint
* positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination
* position.
*
*
*
*
* @param legs
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the
* waypoint positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the
* destination position.
*
*
*/
public void setLegs(java.util.Collection legs) {
if (legs == null) {
this.legs = null;
return;
}
this.legs = new java.util.ArrayList(legs);
}
/**
*
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the waypoint
* positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination
* position.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLegs(java.util.Collection)} or {@link #withLegs(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param legs
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the
* waypoint positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the
* destination position.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteResult withLegs(Leg... legs) {
if (this.legs == null) {
setLegs(new java.util.ArrayList(legs.length));
}
for (Leg ele : legs) {
this.legs.add(ele);
}
return this;
}
/**
*
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the waypoint
* positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination
* position.
*
*
*
*
* @param legs
* Contains details about each path between a pair of positions included along a route such as:
* StartPosition, EndPosition, Distance, DurationSeconds,
* Geometry, and Steps. 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 . The EndPosition is the
* waypoint positon.
*
*
* -
*
* Leg 2: The StartPosition is the waypoint position. The EndPosition is the
* destination position.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteResult withLegs(java.util.Collection legs) {
setLegs(legs);
return this;
}
/**
*
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*
*
* @param summary
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*/
public void setSummary(CalculateRouteSummary summary) {
this.summary = summary;
}
/**
*
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*
*
* @return Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*/
public CalculateRouteSummary getSummary() {
return this.summary;
}
/**
*
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
*
*
* @param summary
* Contains information about the whole route, such as: RouteBBox, DataSource,
* Distance, DistanceUnit, and DurationSeconds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteResult withSummary(CalculateRouteSummary summary) {
setSummary(summary);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLegs() != null)
sb.append("Legs: ").append(getLegs()).append(",");
if (getSummary() != null)
sb.append("Summary: ").append(getSummary());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CalculateRouteResult == false)
return false;
CalculateRouteResult other = (CalculateRouteResult) obj;
if (other.getLegs() == null ^ this.getLegs() == null)
return false;
if (other.getLegs() != null && other.getLegs().equals(this.getLegs()) == false)
return false;
if (other.getSummary() == null ^ this.getSummary() == null)
return false;
if (other.getSummary() != null && other.getSummary().equals(this.getSummary()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLegs() == null) ? 0 : getLegs().hashCode());
hashCode = prime * hashCode + ((getSummary() == null) ? 0 : getSummary().hashCode());
return hashCode;
}
@Override
public CalculateRouteResult clone() {
try {
return (CalculateRouteResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}