Class CalculateRoutesRequest

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.CalculateRoutesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CalculateRoutesRequest.Builder,CalculateRoutesRequest>
@Generated("software.amazon.awssdk:codegen") public final class CalculateRoutesRequest extends GeoRoutesRequest implements ToCopyableBuilder<CalculateRoutesRequest.Builder,CalculateRoutesRequest>

  • Method Details

    • allow

      public final RouteAllowOptions allow()

      Features that are allowed while calculating a route.

      Returns:
      Features that are allowed while calculating a route.

    • arrivalTime

      public final String arrivalTime()

      Time of arrival at the destination.

      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:
      Time of arrival at the destination.

      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

    • avoid

      public final RouteAvoidanceOptions avoid()

      Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

      Returns:
      Features that are avoided while calculating a route. Avoidance is on a best-case basis. If an avoidance can't be satisfied for a particular case, it violates the avoidance and the returned response produces a notice for the violation.

    • departNow

      public final Boolean departNow()

      Uses the current time as the time of departure.

      Returns:
      Uses the current time as the time of departure.

    • departureTime

      public final String departureTime()

      Time of departure from thr origin.

      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:
      Time of departure from thr origin.

      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 RouteDestinationOptions destinationOptions()

      Destination related options.

      Returns:
      Destination related options.

    • driver

      public final RouteDriverOptions driver()

      Driver related options.

      Returns:
      Driver related options.

    • exclude

      public final RouteExclusionOptions exclude()

      Features to be strictly excluded while calculating the route.

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

    • instructionsMeasurementSystem

      public final MeasurementSystem instructionsMeasurementSystem()

      Measurement system to be used for instructions within steps in the response.

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

      Returns:
      Measurement system to be used for instructions within steps in the response.
      See Also:

    • instructionsMeasurementSystemAsString

      public final String instructionsMeasurementSystemAsString()

      Measurement system to be used for instructions within steps in the response.

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

      Returns:
      Measurement system to be used for instructions within steps in the response.
      See Also:

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

    • hasLanguages

      public final boolean hasLanguages()
      For responses, this returns true if the service returned a value for the Languages 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.

    • languages

      public final List<String> languages()

      List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

      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 hasLanguages() method.

      Returns:
      List of languages for instructions within steps in the response.

      Instructions in the requested language are returned only if they are available.

    • legAdditionalFeatures

      public final List<RouteLegAdditionalFeature> legAdditionalFeatures()

      A list of optional additional parameters such as timezone that can be requested for each result.

      • Elevation: Retrieves the elevation information for each location.

      • Incidents: Provides information on traffic incidents along the route.

      • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

      • Summary: Returns a summary of the route, including distance and duration.

      • Tolls: Supplies toll cost information along the route.

      • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

      • TruckRoadTypes: Returns information about road types suitable for trucks.

      • TypicalDuration: Gives typical travel duration based on historical data.

      • Zones: Specifies the time zone information for each waypoint.

      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 hasLegAdditionalFeatures() method.

      Returns:
      A list of optional additional parameters such as timezone that can be requested for each result.

      • Elevation: Retrieves the elevation information for each location.

      • Incidents: Provides information on traffic incidents along the route.

      • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

      • Summary: Returns a summary of the route, including distance and duration.

      • Tolls: Supplies toll cost information along the route.

      • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

      • TruckRoadTypes: Returns information about road types suitable for trucks.

      • TypicalDuration: Gives typical travel duration based on historical data.

      • Zones: Specifies the time zone information for each waypoint.

    • hasLegAdditionalFeatures

      public final boolean hasLegAdditionalFeatures()
      For responses, this returns true if the service returned a value for the LegAdditionalFeatures 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.

    • legAdditionalFeaturesAsStrings

      public final List<String> legAdditionalFeaturesAsStrings()

      A list of optional additional parameters such as timezone that can be requested for each result.

      • Elevation: Retrieves the elevation information for each location.

      • Incidents: Provides information on traffic incidents along the route.

      • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

      • Summary: Returns a summary of the route, including distance and duration.

      • Tolls: Supplies toll cost information along the route.

      • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

      • TruckRoadTypes: Returns information about road types suitable for trucks.

      • TypicalDuration: Gives typical travel duration based on historical data.

      • Zones: Specifies the time zone information for each waypoint.

      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 hasLegAdditionalFeatures() method.

      Returns:
      A list of optional additional parameters such as timezone that can be requested for each result.

      • Elevation: Retrieves the elevation information for each location.

      • Incidents: Provides information on traffic incidents along the route.

      • PassThroughWaypoints: Indicates waypoints that are passed through without stopping.

      • Summary: Returns a summary of the route, including distance and duration.

      • Tolls: Supplies toll cost information along the route.

      • TravelStepInstructions: Provides step-by-step instructions for travel along the route.

      • TruckRoadTypes: Returns information about road types suitable for trucks.

      • TypicalDuration: Gives typical travel duration based on historical data.

      • Zones: Specifies the time zone information for each waypoint.

    • legGeometryFormat

      public final GeometryFormat legGeometryFormat()

      Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

      FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

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

      Returns:
      Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

      FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      See Also:

    • legGeometryFormatAsString

      public final String legGeometryFormatAsString()

      Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

      FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

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

      Returns:
      Specifies the format of the geometry returned for each leg of the route. You can choose between two different geometry encoding formats.

      FlexiblePolyline: A compact and precise encoding format for the leg geometry. For more information on the format, see the GitHub repository for FlexiblePolyline .

      Simple: A less compact encoding, which is easier to decode but may be less precise and result in larger payloads.

      See Also:

    • maxAlternatives

      public final Integer maxAlternatives()

      Maximum number of alternative routes to be provided in the response, if available.

      Returns:
      Maximum number of alternative routes to be provided in the response, if available.

    • optimizeRoutingFor

      public final RoutingObjective optimizeRoutingFor()

      Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

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

      Returns:
      Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

      See Also:

    • optimizeRoutingForAsString

      public final String optimizeRoutingForAsString()

      Specifies the optimization criteria for calculating a route.

      Default Value: FastestRoute

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

      Returns:
      Specifies the optimization criteria for calculating a route.

      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 RouteOriginOptions originOptions()

      Origin related options.

      Returns:
      Origin related options.

    • spanAdditionalFeatures

      public final List<RouteSpanAdditionalFeature> spanAdditionalFeatures()

      A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

      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 hasSpanAdditionalFeatures() method.

      Returns:
      A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

    • hasSpanAdditionalFeatures

      public final boolean hasSpanAdditionalFeatures()
      For responses, this returns true if the service returned a value for the SpanAdditionalFeatures 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.

    • spanAdditionalFeaturesAsStrings

      public final List<String> spanAdditionalFeaturesAsStrings()

      A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

      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 hasSpanAdditionalFeatures() method.

      Returns:
      A list of optional features such as SpeedLimit that can be requested for a Span. A span is a section of a Leg for which the requested features have the same values.

    • tolls

      public final RouteTollOptions tolls()

      Toll related options.

      Returns:
      Toll related options.

    • traffic

      public final RouteTrafficOptions traffic()

      Traffic related options.

      Returns:
      Traffic related options.

    • travelMode

      public final RouteTravelMode 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 RouteTravelMode.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 RouteTravelMode.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 RouteTravelModeOptions travelModeOptions()

      Travel mode related options for the provided travel mode.

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

    • travelStepType

      public final RouteTravelStepType travelStepType()

      Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

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

      Returns:
      Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.
      See Also:

    • travelStepTypeAsString

      public final String travelStepTypeAsString()

      Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.

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

      Returns:
      Type of step returned by the response. Default provides basic steps intended for web based applications. TurnByTurn provides detailed instructions with more granularity intended for a turn based navigation system.
      See Also:

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

    • builder

      public static CalculateRoutesRequest.Builder builder()

    • serializableBuilderClass

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