Class RouteTrafficOptions

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

Traffic options for the route.

See Also:

  • Method Details

    • flowEventThresholdOverride

      public final Long flowEventThresholdOverride()

      Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

      Returns:
      Duration for which flow traffic is considered valid. For this period, the flow traffic is used over historical traffic data. Flow traffic refers to congestion, which changes very quickly. Duration in seconds for which flow traffic event would be considered valid. While flow traffic event is valid it will be used over the historical traffic data.

    • usage

      public final TrafficUsage usage()

      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      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:
      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      See Also:

    • usageAsString

      public final String usageAsString()

      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      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:
      Specifies how traffic data should be used when calculating routes.

      Default Value: UseTrafficData

      Traffic data usage depends on the time parameters in your route request:

      • When Usage is set to UseTrafficData:

        • If DepartNow is set to true, or if you specify DepartureTime or ArrivalTime, then all traffic data is considered (including live traffic and closures).

        • If DepartNow, DepartureTime, and ArrivalTime are all unspecified, then only long-term closures are considered, regardless of this setting.

      • When Usage is set to IgnoreTrafficData, then all traffic data is ignored regardless of the time parameters in your route request.

      See Also:

    • toBuilder

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

    • builder

      public static RouteTrafficOptions.Builder builder()

    • serializableBuilderClass

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