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("software.amazon.awssdk:codegen") public final class CalculateRouteMatrixResponse extends LocationResponse implements ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

Returns the result of the route matrix calculation.

  • 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 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()
      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 interface ToCopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.