Interface CalculateRouteMatrixResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>, LocationResponse.Builder, SdkBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CalculateRouteMatrixResponse

public static interface CalculateRouteMatrixResponse.Builder extends LocationResponse.Builder, SdkPojo, CopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>
  • Method Details

    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDeparturePositions

      CalculateRouteMatrixResponse.Builder snappedDeparturePositions(Collection<? extends Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDeparturePositions

      CalculateRouteMatrixResponse.Builder snappedDeparturePositions(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDestinationPositions

      CalculateRouteMatrixResponse.Builder snappedDestinationPositions(Collection<? extends Collection<Double>> snappedDestinationPositions)

      The list of destination positions for the route matrix used for calculation of the RouteMatrix.

      Parameters:
      snappedDestinationPositions - The list of destination positions for the route matrix used for calculation of the RouteMatrix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • snappedDestinationPositions

      CalculateRouteMatrixResponse.Builder snappedDestinationPositions(Collection<Double>... snappedDestinationPositions)

      The list of destination positions for the route matrix used for calculation of the RouteMatrix.

      Parameters:
      snappedDestinationPositions - The list of destination positions for the route matrix used for calculation of the RouteMatrix.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • summary

      Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

      Parameters:
      summary - Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • summary

      Contains information about the route matrix, DataSource, DistanceUnit, RouteCount and ErrorCount.

      This is a convenience method that creates an instance of the CalculateRouteMatrixSummary.Builder avoiding the need to create one manually via CalculateRouteMatrixSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to summary(CalculateRouteMatrixSummary).

      Parameters:
      summary - a consumer that will call methods on CalculateRouteMatrixSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: