Class RouteMatrixBoundaryGeometry

java.lang.Object
software.amazon.awssdk.services.georoutes.model.RouteMatrixBoundaryGeometry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RouteMatrixBoundaryGeometry.Builder,RouteMatrixBoundaryGeometry>
@Generated("software.amazon.awssdk:codegen") public final class RouteMatrixBoundaryGeometry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RouteMatrixBoundaryGeometry.Builder,RouteMatrixBoundaryGeometry>

Geometry of the routing boundary.

See Also:

  • Method Details

    • autoCircle

      public final 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.

      Returns:
      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.

    • circle

      public final 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.

      Returns:
      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.

    • hasBoundingBox

      public final boolean hasBoundingBox()
      For responses, this returns true if the service returned a value for the BoundingBox 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.

    • boundingBox

      public final List<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.

      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 hasBoundingBox() method.

      Returns:
      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.

    • hasPolygon

      public final boolean hasPolygon()
      For responses, this returns true if the service returned a value for the Polygon 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.

    • polygon

      public final List<List<List<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.

      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 hasPolygon() method.

      Returns:
      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.

    • toBuilder

      public RouteMatrixBoundaryGeometry.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<RouteMatrixBoundaryGeometry.Builder,RouteMatrixBoundaryGeometry>
      Returns:
      a builder for type T

    • builder

      public static RouteMatrixBoundaryGeometry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RouteMatrixBoundaryGeometry.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.