Interface CalculateRouteMatrixResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>, GeoRoutesResponse.Builder, SdkBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CalculateRouteMatrixResponse
@Mutable @NotThreadSafe public static interface CalculateRouteMatrixResponse.Builder extends GeoRoutesResponse.Builder, SdkPojo, CopyableBuilder<CalculateRouteMatrixResponse.Builder,CalculateRouteMatrixResponse>

  • Method Details

    • errorCount

      CalculateRouteMatrixResponse.Builder errorCount(Integer errorCount)

      The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.

      Parameters:
      errorCount - The count of error results in the route matrix. If this number is 0, all routes were calculated successfully.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pricingBucket

      CalculateRouteMatrixResponse.Builder pricingBucket(String pricingBucket)

      The pricing bucket for which the query is charged at.

      Parameters:
      pricingBucket - The pricing bucket for which the query is charged at.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeMatrix

      CalculateRouteMatrixResponse.Builder routeMatrix(Collection<? extends Collection<RouteMatrixEntry>> routeMatrix)

      The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

      Parameters:
      routeMatrix - The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routeMatrix

      CalculateRouteMatrixResponse.Builder routeMatrix(Collection<RouteMatrixEntry>... routeMatrix)

      The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.

      Parameters:
      routeMatrix - The calculated route matrix containing the results for all pairs of Origins to Destination positions. Each row corresponds to one entry in Origins. Each entry in the row corresponds to the route from that entry in Origins to an entry in Destination positions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routingBoundary

      CalculateRouteMatrixResponse.Builder routingBoundary(RouteMatrixBoundary routingBoundary)

      Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

      When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

      Parameters:
      routingBoundary - Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

      When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • routingBoundary

      default CalculateRouteMatrixResponse.Builder routingBoundary(Consumer<RouteMatrixBoundary.Builder> routingBoundary)

      Boundary within which the matrix is to be calculated. All data, origins and destinations outside the boundary are considered invalid.

      When request routing boundary was set as AutoCircle, the response routing boundary will return Circle derived from the AutoCircle settings.

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

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

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