Class RouteMatchingOptions

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

Options related to route matching.

See Also:

  • Method Details

    • nameHint

      public final String nameHint()

      Attempts to match the provided position to a road similar to the provided name.

      Returns:
      Attempts to match the provided position to a road similar to the provided name.

    • onRoadThreshold

      public final Long onRoadThreshold()

      If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

      Unit: meters

      Returns:
      If the distance to a highway/bridge/tunnel/sliproad is within threshold, the waypoint will be snapped to the highway/bridge/tunnel/sliproad.

      Unit: meters

    • radius

      public final Long radius()

      Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

      Unit: Meters

      Returns:
      Considers all roads within the provided radius to match the provided destination to. The roads that are considered are determined by the provided Strategy.

      Unit: Meters

    • strategy

      public final MatchingStrategy strategy()

      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

      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:
      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
      See Also:

    • strategyAsString

      public final String strategyAsString()

      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.

      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:
      Strategy that defines matching of the position onto the road network. MatchAny considers all roads possible, whereas MatchMostSignificantRoad matches to the most significant road.
      See Also:

    • toBuilder

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

    • builder

      public static RouteMatchingOptions.Builder builder()

    • serializableBuilderClass

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