Package software.amazon.awssdk.services.georoutes.model

Class CalculateIsolinesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CalculateIsolinesRequest
extends GeoRoutesRequest
implements ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CalculateIsolinesRequest.Builder

Method Summary

Modifier and Type	Method	Description
IsolineAllowOptions	allow()	Features that are allowed while calculating.
String	arrivalTime()	Time of arrival at the destination.
IsolineAvoidanceOptions	avoid()	Features that are avoided while calculating a route.
static CalculateIsolinesRequest.Builder	builder()
Boolean	departNow()	Uses the current time as the time of departure.
String	departureTime()	Time of departure from thr origin.
List<Double>	destination()	The final position for the route.
IsolineDestinationOptions	destinationOptions()	Destination related options.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestination()	For responses, this returns true if the service returned a value for the Destination property.
int	hashCode()
boolean	hasOrigin()	For responses, this returns true if the service returned a value for the Origin property.
GeometryFormat	isolineGeometryFormat()	The format of the returned IsolineGeometry.
String	isolineGeometryFormatAsString()	The format of the returned IsolineGeometry.
IsolineGranularityOptions	isolineGranularity()	Defines the granularity of the returned Isoline
String	key()	Optional: The API key to be used for authorization.
IsolineOptimizationObjective	optimizeIsolineFor()	Specifies the optimization criteria for when calculating an isoline.
String	optimizeIsolineForAsString()	Specifies the optimization criteria for when calculating an isoline.
RoutingObjective	optimizeRoutingFor()	Specifies the optimization criteria for calculating a route.
String	optimizeRoutingForAsString()	Specifies the optimization criteria for calculating a route.
List<Double>	origin()	The start position for the route.
IsolineOriginOptions	originOptions()	Origin related options.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CalculateIsolinesRequest.Builder>	serializableBuilderClass()
IsolineThresholds	thresholds()	Threshold to be used for the isoline calculation.
CalculateIsolinesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IsolineTrafficOptions	traffic()	Traffic related options.
IsolineTravelMode	travelMode()	Specifies the mode of transport when calculating a route.
String	travelModeAsString()	Specifies the mode of transport when calculating a route.
IsolineTravelModeOptions	travelModeOptions()	Travel mode related options for the provided travel mode.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

allow

public final IsolineAllowOptions 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 IsolineAvoidanceOptions 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 IsolineDestinationOptions destinationOptions()

Destination related options.

Returns:

Destination related options.

isolineGeometryFormat

public final GeometryFormat isolineGeometryFormat()

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

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

Returns:

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

See Also:

GeometryFormat

isolineGeometryFormatAsString

public final String isolineGeometryFormatAsString()

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

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

Returns:

The format of the returned IsolineGeometry.

Default Value:FlexiblePolyline

See Also:

GeometryFormat

isolineGranularity

public final IsolineGranularityOptions isolineGranularity()

Defines the granularity of the returned Isoline

Returns:

Defines the granularity of the returned Isoline

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.

optimizeIsolineFor

public final IsolineOptimizationObjective optimizeIsolineFor()

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

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

Returns:

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

See Also:

IsolineOptimizationObjective

optimizeIsolineForAsString

public final String optimizeIsolineForAsString()

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

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

Returns:

Specifies the optimization criteria for when calculating an isoline. AccurateCalculation generates an isoline of higher granularity that is more precise. FastCalculation generates an isoline faster by reducing the granularity, and in turn the quality of the isoline. BalancedCalculation generates an isoline by balancing between quality and performance.

Default Value: BalancedCalculation

See Also:

IsolineOptimizationObjective

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:

RoutingObjective

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:

RoutingObjective

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

Origin related options.

Returns:

Origin related options.

thresholds

public final IsolineThresholds thresholds()

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

Returns:

Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.

traffic

public final IsolineTrafficOptions traffic()

Traffic related options.

Returns:

Traffic related options.

travelMode

public final IsolineTravelMode travelMode()

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

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

If the service returns an enum value that is not available in the current SDK version, travelMode will return IsolineTravelMode.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.

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

See Also:

IsolineTravelMode

travelModeAsString

public final String travelModeAsString()

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

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

If the service returns an enum value that is not available in the current SDK version, travelMode will return IsolineTravelMode.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.

The mode Scooter also applies to motorcycles, set to Scooter when wanted to calculate options for motorcycles.

Default Value: Car

See Also:

IsolineTravelMode

travelModeOptions

public final IsolineTravelModeOptions travelModeOptions()

Travel mode related options for the provided travel mode.

Returns:

Travel mode related options for the provided travel mode.

toBuilder

public CalculateIsolinesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CalculateIsolinesRequest.Builder,CalculateIsolinesRequest>

Specified by:

toBuilder in class GeoRoutesRequest

builder

public static CalculateIsolinesRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo