Class IsolineCarOptions

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

Vehicle characteristics and preferences that affect routing for passenger cars. This includes vehicle type, occupancy, and speed restrictions that may influence which roads can be used and expected travel times.

See Also:

  • Method Details

    • engineType

      public final IsolineEngineType engineType()

      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

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

      Returns:
      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

      See Also:

    • engineTypeAsString

      public final String engineTypeAsString()

      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

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

      Returns:
      The type of engine powering the vehicle, which may affect route calculation due to road restrictions or vehicle characteristics.

      • INTERNAL_COMBUSTION—Standard gasoline or diesel engine.

      • ELECTRIC—Battery electric vehicle.

      • PLUGIN_HYBRID—Combination of electric and internal combustion engines with plug-in charging capability.

      See Also:

    • licensePlate

      public final IsolineVehicleLicensePlate licensePlate()

      License plate information used in regions where road access or routing restrictions are based on license plate numbers.

      Returns:
      License plate information used in regions where road access or routing restrictions are based on license plate numbers.

    • maxSpeed

      public final Double maxSpeed()

      The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).

      Unit: kilometers per hour

      Returns:
      The maximum speed of the vehicle in kilometers per hour. When specified, routes will not include roads with higher speed limits. Valid values range from 3.6 km/h (1 m/s) to 252 km/h (70 m/s).

      Unit: kilometers per hour

    • occupancy

      public final Integer occupancy()

      The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

      Default value: 1

      Returns:
      The number of occupants in the vehicle. This can affect route calculations by enabling the use of high-occupancy vehicle (HOV) lanes where minimum occupancy requirements are met.

      Default value: 1

    • toBuilder

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

    • builder

      public static IsolineCarOptions.Builder builder()

    • serializableBuilderClass

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