Class IsolineTrafficOptions

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

Controls how real-time and historical traffic data is used when calculating reachable areas. This affects both the size and shape of isolines by accounting for expected travel speeds based on congestion patterns.

See Also:

  • Method Details

    • flowEventThresholdOverride

      public final Long flowEventThresholdOverride()

      The duration in seconds that real-time congestion data is considered valid before reverting to historical traffic patterns. This helps balance between using current conditions and more predictable historical data when calculating travel times.

      Unit: seconds

      Returns:
      The duration in seconds that real-time congestion data is considered valid before reverting to historical traffic patterns. This helps balance between using current conditions and more predictable historical data when calculating travel times.

      Unit: seconds

    • usage

      public final TrafficUsage usage()

      Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.

      Default value: UseTrafficData

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

      Returns:
      Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.

      Default value: UseTrafficData

      See Also:

    • usageAsString

      public final String usageAsString()

      Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.

      Default value: UseTrafficData

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

      Returns:
      Controls whether traffic data is used in calculations. UseTrafficData considers both real-time congestion and historical patterns, while IgnoreTrafficData calculates routes based solely on road types and speed limits. Using traffic data provides more accurate real-world estimates but may produce different results at different times of day.

      Default value: UseTrafficData

      See Also:

    • toBuilder

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

    • builder

      public static IsolineTrafficOptions.Builder builder()

    • serializableBuilderClass

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