Class OptimizeWaypointsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest
software.amazon.awssdk.services.georoutes.model.OptimizeWaypointsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>
@Generated("software.amazon.awssdk:codegen") public final class OptimizeWaypointsRequest extends GeoRoutesRequest implements ToCopyableBuilder<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>

  • Method Details

    • avoid

      public final WaypointOptimizationAvoidanceOptions avoid()

      Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

      Returns:
      Features that are avoided. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, this setting is ignored.

    • clustering

      public final WaypointOptimizationClusteringOptions clustering()

      Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

      Returns:
      Clustering allows you to specify how nearby waypoints can be clustered to improve the optimized sequence.

    • departureTime

      public final String departureTime()

      Departure time from the waypoint.

      Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

      Returns:
      Departure time from the waypoint.

      Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

      Examples:

      2020-04-22T17:57:24Z

      2020-04-22T17:57:24+02:00

    • hasDestination

      public final boolean hasDestination()
      For responses, this returns true if the service returned a value for the Destination property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • destination

      public final List<Double> destination()

      The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude] .

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestination() method.

      Returns:
      The final position for the route in the World Geodetic System (WGS 84) format: [longitude, latitude].

    • destinationOptions

      public final WaypointOptimizationDestinationOptions destinationOptions()

      Destination related options.

      Returns:
      Destination related options.

    • driver

      public final WaypointOptimizationDriverOptions driver()

      Driver related options.

      Returns:
      Driver related options.

    • exclude

      public final WaypointOptimizationExclusionOptions exclude()

      Features to be strictly excluded while calculating the route.

      Returns:
      Features to be strictly excluded while calculating the route.

    • key

      public final String key()

      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

      Returns:
      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    • optimizeSequencingFor

      public final WaypointOptimizationSequencingObjective optimizeSequencingFor()

      Specifies the optimization criteria for the calculated sequence.

      Default Value: FastestRoute.

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

      Returns:
      Specifies the optimization criteria for the calculated sequence.

      Default Value: FastestRoute.

      See Also:

    • optimizeSequencingForAsString

      public final String optimizeSequencingForAsString()

      Specifies the optimization criteria for the calculated sequence.

      Default Value: FastestRoute.

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

      Returns:
      Specifies the optimization criteria for the calculated sequence.

      Default Value: FastestRoute.

      See Also:

    • hasOrigin

      public final boolean hasOrigin()
      For responses, this returns true if the service returned a value for the Origin property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • origin

      public final List<Double> origin()

      The start position for the route.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOrigin() method.

      Returns:
      The start position for the route.

    • originOptions

      public final WaypointOptimizationOriginOptions originOptions()

      Origin related options.

      Returns:
      Origin related options.

    • traffic

      public final WaypointOptimizationTrafficOptions traffic()

      Traffic-related options.

      Returns:
      Traffic-related options.

    • travelMode

      public final WaypointOptimizationTravelMode travelMode()

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

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

      Returns:
      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      See Also:

    • travelModeAsString

      public final String travelModeAsString()

      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

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

      Returns:
      Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.

      Default Value: Car

      See Also:

    • travelModeOptions

      public final WaypointOptimizationTravelModeOptions travelModeOptions()

      Travel mode related options for the provided travel mode.

      Returns:
      Travel mode related options for the provided travel mode.

    • hasWaypoints

      public final boolean hasWaypoints()
      For responses, this returns true if the service returned a value for the Waypoints property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • waypoints

      public final List<WaypointOptimizationWaypoint> waypoints()

      List of waypoints between the Origin and Destination.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWaypoints() method.

      Returns:
      List of waypoints between the Origin and Destination.

    • toBuilder

      public OptimizeWaypointsRequest.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<OptimizeWaypointsRequest.Builder,OptimizeWaypointsRequest>
      Specified by:
      toBuilder in class GeoRoutesRequest
      Returns:
      a builder for type T

    • builder

      public static OptimizeWaypointsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OptimizeWaypointsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.