Class RouteMatrixAutoCircle

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

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.

See Also:

  • Method Details

    • margin

      public final Long margin()

      The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.

      The total of MaxRadius and Margin must be less than or equal to 200,000 meters.

      Returns:
      The minimal distance, in meters, between any waypoint and the perimeter of the circle auto-defined for the boundary. Some margin is usually recommended so that the routing has enough leeway to travel from one waypoint to another optimally without conflicting with the routing boundary.

      The total of MaxRadius and Margin must be less than or equal to 200,000 meters.

    • maxRadius

      public final Long maxRadius()

      The maximum radius, in meters, that the auto-defined Circle boundary should have, before the Margin distance is added to the circle.

      The total of MaxRadius and Margin must be less than or equal to 200,000 meters.

      Returns:
      The maximum radius, in meters, that the auto-defined Circle boundary should have, before the Margin distance is added to the circle.

      The total of MaxRadius and Margin must be less than or equal to 200,000 meters.

    • toBuilder

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

    • builder

      public static RouteMatrixAutoCircle.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RouteMatrixAutoCircle.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.