Class WaypointOptimizationDriverOptions

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

Driver related options.

See Also:

  • Method Details

    • restCycles

      public final WaypointOptimizationRestCycles restCycles()

      Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

      Returns:
      Driver work-rest schedules defined by a short and long cycle. A rest needs to be taken after the short work duration. The short cycle can be repeated until you hit the long work duration, at which point the long rest duration should be taken before restarting.

    • restProfile

      public final WaypointOptimizationRestProfile restProfile()

      Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

      Returns:
      Pre defined rest profiles for a driver schedule. The only currently supported profile is EU.

    • treatServiceTimeAs

      public final WaypointOptimizationServiceTimeTreatment treatServiceTimeAs()

      If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.

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

      Returns:
      If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.
      See Also:

    • treatServiceTimeAsAsString

      public final String treatServiceTimeAsAsString()

      If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.

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

      Returns:
      If the service time provided at a waypoint/destination should be considered as rest or work. This contributes to the total time breakdown returned within the response.
      See Also:

    • toBuilder

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

    • builder

      public static WaypointOptimizationDriverOptions.Builder builder()

    • serializableBuilderClass

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