Interface RouteMatrixBoundaryGeometry.Builder

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

  • Method Details

    • autoCircle

      RouteMatrixBoundaryGeometry.Builder autoCircle(RouteMatrixAutoCircle autoCircle)

      AutoCircle requests the route matrix service to define a Circle boundary that best attempts to include most waypoints (Origins and Destinations) using the AutoCircle settings. Any waypoints outside of the auto-defined Circle boundary will be considered out of the routing boundary, which results in a route matrix entry error.

      AutoCircle is only used in the request to configure a Circle for the route calculation. The derived Circle will also be provided in the response.

      Parameters:
      autoCircle - AutoCircle requests the route matrix service to define a Circle boundary that best attempts to include most waypoints (Origins and Destinations) using the AutoCircle settings. Any waypoints outside of the auto-defined Circle boundary will be considered out of the routing boundary, which results in a route matrix entry error.

      AutoCircle is only used in the request to configure a Circle for the route calculation. The derived Circle will also be provided in the response.

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

    • autoCircle

      default RouteMatrixBoundaryGeometry.Builder autoCircle(Consumer<RouteMatrixAutoCircle.Builder> autoCircle)

      AutoCircle requests the route matrix service to define a Circle boundary that best attempts to include most waypoints (Origins and Destinations) using the AutoCircle settings. Any waypoints outside of the auto-defined Circle boundary will be considered out of the routing boundary, which results in a route matrix entry error.

      AutoCircle is only used in the request to configure a Circle for the route calculation. The derived Circle will also be provided in the response.

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

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

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

    • circle

      RouteMatrixBoundaryGeometry.Builder circle(Circle circle)

      Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error.

      You can specify a Circle directly in the request, or it will be auto-derived when AutoCircle is used. When AutoCircle is set in the request, the response routing boundary will return Circle derived from the AutoCircle settings.

      Parameters:
      circle - Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error.

      You can specify a Circle directly in the request, or it will be auto-derived when AutoCircle is used. When AutoCircle is set in the request, 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.

    • circle

      default RouteMatrixBoundaryGeometry.Builder circle(Consumer<Circle.Builder> circle)

      Geometry defined as a circle. The circle defines the routing boundary area. Any waypoints outside the circle will result in a route matrix entry error.

      You can specify a Circle directly in the request, or it will be auto-derived when AutoCircle is used. When AutoCircle is set in the request, the response routing boundary will return Circle derived from the AutoCircle settings.

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

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

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

    • boundingBox

      RouteMatrixBoundaryGeometry.Builder boundingBox(Collection<Double> boundingBox)

      Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Diagonal distance of the bounding box must be less than or equal to 400,000 meters.

      Parameters:
      boundingBox - Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Diagonal distance of the bounding box must be less than or equal to 400,000 meters.

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

    • boundingBox

      RouteMatrixBoundaryGeometry.Builder boundingBox(Double... boundingBox)

      Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Diagonal distance of the bounding box must be less than or equal to 400,000 meters.

      Parameters:
      boundingBox - Geometry defined as a bounding box. The first pair represents the X and Y coordinates (longitude and latitude,) of the southwest corner of the bounding box; the second pair represents the X and Y coordinates (longitude and latitude) of the northeast corner.

      Diagonal distance of the bounding box must be less than or equal to 400,000 meters.

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

    • polygon

      RouteMatrixBoundaryGeometry.Builder polygon(Collection<? extends Collection<? extends Collection<Double>>> polygon)

      Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.

      The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].

      Maximum distance between any two vertices must be less than or equal to 400,000 meters.

      Parameters:
      polygon - Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.

      The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].

      Maximum distance between any two vertices must be less than or equal to 400,000 meters.

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

    • polygon

      RouteMatrixBoundaryGeometry.Builder polygon(Collection<? extends Collection<Double>>... polygon)

      Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.

      The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].

      Maximum distance between any two vertices must be less than or equal to 400,000 meters.

      Parameters:
      polygon - Geometry defined as a polygon with only one linear ring. A linear ring is a closed sequence of four or more coordinates. The first and last coordinates are the same, forming a closed boundary. Each coordinate is a position in [longitude, latitude] format.

      The structure is an array of linear rings (only 1 allowed). Each linear ring is an array of coordinates (minimum 4), and each coordinate is an array of two doubles [longitude, latitude].

      Maximum distance between any two vertices must be less than or equal to 400,000 meters.

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