Class IsolineMatchingOptions

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

Controls how origin and destination points are matched to the road network when they don't fall exactly on a road. Matching options help ensure realistic routing by connecting points to appropriate roads.

See Also:

  • Method Details

    • nameHint

      public final String nameHint()

      The expected street name near the point. Helps disambiguate matching when multiple roads are within range.

      Returns:
      The expected street name near the point. Helps disambiguate matching when multiple roads are within range.

    • onRoadThreshold

      public final Long onRoadThreshold()

      The maximum distance in meters that a point can be from a road while still being considered "on" that road. Points further than this distance require explicit matching.

      Unit: meters

      Returns:
      The maximum distance in meters that a point can be from a road while still being considered "on" that road. Points further than this distance require explicit matching.

      Unit: meters

    • radius

      public final Long radius()

      The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy

      Unit: meters

      Returns:
      The maximum distance in meters to search for roads to match to. Points with no roads within this radius will fail to match. The roads that are considered within this radius are determined by the specified Strategy

      Unit: meters

    • strategy

      public final MatchingStrategy strategy()

      Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.

      If the service returns an enum value that is not available in the current SDK version, strategy will return MatchingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from strategyAsString().

      Returns:
      Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.

      If the service returns an enum value that is not available in the current SDK version, strategy will return MatchingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from strategyAsString().

      Returns:
      Determines how points are matched to the road network. MatchAny finds the nearest viable road segment, while MatchMostSignificantRoad prioritizes major roads.
      See Also:

    • toBuilder

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

    • builder

      public static IsolineMatchingOptions.Builder builder()

    • serializableBuilderClass

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