Interface CalculateIsolinesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CalculateIsolinesRequest.Builder,,CalculateIsolinesRequest> GeoRoutesRequest.Builder,SdkBuilder<CalculateIsolinesRequest.Builder,,CalculateIsolinesRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
CalculateIsolinesRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CalculateIsolinesRequest.Builderallow(Consumer<IsolineAllowOptions.Builder> allow) Features that are allowed while calculating an isoline.allow(IsolineAllowOptions allow) Features that are allowed while calculating an isoline.arrivalTime(String arrivalTime) Time of arrival at the destination.default CalculateIsolinesRequest.BuilderFeatures that are avoided while calculating a route.avoid(IsolineAvoidanceOptions avoid) Features that are avoided while calculating a route.Uses the current time as the time of departure.departureTime(String departureTime) Time of departure from thr origin.destination(Double... destination) The final position for the route.destination(Collection<Double> destination) The final position for the route.default CalculateIsolinesRequest.BuilderdestinationOptions(Consumer<IsolineDestinationOptions.Builder> destinationOptions) Destination related options.destinationOptions(IsolineDestinationOptions destinationOptions) Destination related options.isolineGeometryFormat(String isolineGeometryFormat) The format of the returned IsolineGeometry.isolineGeometryFormat(GeometryFormat isolineGeometryFormat) The format of the returned IsolineGeometry.default CalculateIsolinesRequest.BuilderisolineGranularity(Consumer<IsolineGranularityOptions.Builder> isolineGranularity) Defines the granularity of the returned Isoline.isolineGranularity(IsolineGranularityOptions isolineGranularity) Defines the granularity of the returned Isoline.Optional: The API key to be used for authorization.optimizeIsolineFor(String optimizeIsolineFor) Specifies the optimization criteria for when calculating an isoline.optimizeIsolineFor(IsolineOptimizationObjective optimizeIsolineFor) Specifies the optimization criteria for when calculating an isoline.optimizeRoutingFor(String optimizeRoutingFor) Specifies the optimization criteria for calculating a route.optimizeRoutingFor(RoutingObjective optimizeRoutingFor) Specifies the optimization criteria for calculating a route.The start position for the route.origin(Collection<Double> origin) The start position for the route.default CalculateIsolinesRequest.BuilderoriginOptions(Consumer<IsolineOriginOptions.Builder> originOptions) Origin related options.originOptions(IsolineOriginOptions originOptions) Origin related options.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CalculateIsolinesRequest.Builderthresholds(Consumer<IsolineThresholds.Builder> thresholds) Threshold to be used for the isoline calculation.thresholds(IsolineThresholds thresholds) Threshold to be used for the isoline calculation.default CalculateIsolinesRequest.Buildertraffic(Consumer<IsolineTrafficOptions.Builder> traffic) Traffic related options.traffic(IsolineTrafficOptions traffic) Traffic related options.travelMode(String travelMode) Specifies the mode of transport when calculating a route.travelMode(IsolineTravelMode travelMode) Specifies the mode of transport when calculating a route.default CalculateIsolinesRequest.BuildertravelModeOptions(Consumer<IsolineTravelModeOptions.Builder> travelModeOptions) Travel mode related options for the provided travel mode.travelModeOptions(IsolineTravelModeOptions travelModeOptions) Travel mode related options for the provided travel mode.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.georoutes.model.GeoRoutesRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
allow
Features that are allowed while calculating an isoline.
- Parameters:
allow- Features that are allowed while calculating an isoline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
allow
Features that are allowed while calculating an isoline.
This is a convenience method that creates an instance of theIsolineAllowOptions.Builderavoiding the need to create one manually viaIsolineAllowOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toallow(IsolineAllowOptions).- Parameters:
allow- a consumer that will call methods onIsolineAllowOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
arrivalTime
Time of arrival at the destination.
Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Parameters:
arrivalTime- Time of arrival at the destination.Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theIsolineAvoidanceOptions.Builderavoiding the need to create one manually viaIsolineAvoidanceOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toavoid(IsolineAvoidanceOptions).- Parameters:
avoid- a consumer that will call methods onIsolineAvoidanceOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
departNow
Uses the current time as the time of departure.
- Parameters:
departNow- Uses the current time as the time of departure.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
departureTime
Time of departure from thr origin.
Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Parameters:
departureTime- Time of departure from thr origin.Time format:
YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mmExamples:
2020-04-22T17:57:24Z2020-04-22T17:57:24+02:00- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destination
The final position for the route. In the World Geodetic System (WGS 84) format:
[longitude, latitude].- Parameters:
destination- The final position for the route. In the World Geodetic System (WGS 84) format:[longitude, latitude].- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destination
The final position for the route. In the World Geodetic System (WGS 84) format:
[longitude, latitude].- Parameters:
destination- The final position for the route. In the World Geodetic System (WGS 84) format:[longitude, latitude].- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationOptions
Destination related options.
- Parameters:
destinationOptions- Destination related options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationOptions
default CalculateIsolinesRequest.Builder destinationOptions(Consumer<IsolineDestinationOptions.Builder> destinationOptions) Destination related options.
This is a convenience method that creates an instance of theIsolineDestinationOptions.Builderavoiding the need to create one manually viaIsolineDestinationOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todestinationOptions(IsolineDestinationOptions).- Parameters:
destinationOptions- a consumer that will call methods onIsolineDestinationOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isolineGeometryFormat
The format of the returned IsolineGeometry.
Default Value:
FlexiblePolyline- Parameters:
isolineGeometryFormat- The format of the returned IsolineGeometry.Default Value:
FlexiblePolyline- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isolineGeometryFormat
The format of the returned IsolineGeometry.
Default Value:
FlexiblePolyline- Parameters:
isolineGeometryFormat- The format of the returned IsolineGeometry.Default Value:
FlexiblePolyline- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
isolineGranularity
Defines the granularity of the returned Isoline.
- Parameters:
isolineGranularity- Defines the granularity of the returned Isoline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isolineGranularity
default CalculateIsolinesRequest.Builder isolineGranularity(Consumer<IsolineGranularityOptions.Builder> isolineGranularity) Defines the granularity of the returned Isoline.
This is a convenience method that creates an instance of theIsolineGranularityOptions.Builderavoiding the need to create one manually viaIsolineGranularityOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toisolineGranularity(IsolineGranularityOptions).- Parameters:
isolineGranularity- a consumer that will call methods onIsolineGranularityOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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- Parameters:
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- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
optimizeIsolineFor
CalculateIsolinesRequest.Builder optimizeIsolineFor(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- Parameters:
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- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
optimizeRoutingFor
Specifies the optimization criteria for calculating a route.
Default Value:
FastestRoute- Parameters:
optimizeRoutingFor- Specifies the optimization criteria for calculating a route.Default Value:
FastestRoute- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
optimizeRoutingFor
Specifies the optimization criteria for calculating a route.
Default Value:
FastestRoute- Parameters:
optimizeRoutingFor- Specifies the optimization criteria for calculating a route.Default Value:
FastestRoute- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
origin
The start position for the route.
- Parameters:
origin- The start position for the route.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origin
The start position for the route.
- Parameters:
origin- The start position for the route.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originOptions
Origin related options.
- Parameters:
originOptions- Origin related options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originOptions
default CalculateIsolinesRequest.Builder originOptions(Consumer<IsolineOriginOptions.Builder> originOptions) Origin related options.
This is a convenience method that creates an instance of theIsolineOriginOptions.Builderavoiding the need to create one manually viaIsolineOriginOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooriginOptions(IsolineOriginOptions).- Parameters:
originOptions- a consumer that will call methods onIsolineOriginOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
thresholds
Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.
You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
- Parameters:
thresholds- Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
thresholds
Threshold to be used for the isoline calculation. Up to 3 thresholds per provided type can be requested.
You incur a calculation charge for each threshold. Using a large amount of thresholds in a request can lead you to incur unexpected charges. See Amazon Location's pricing page for more information.
This is a convenience method that creates an instance of theIsolineThresholds.Builderavoiding the need to create one manually viaIsolineThresholds.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tothresholds(IsolineThresholds).- Parameters:
thresholds- a consumer that will call methods onIsolineThresholds.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
traffic
Traffic related options.
- Parameters:
traffic- Traffic related options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
traffic
Traffic related options.
This is a convenience method that creates an instance of theIsolineTrafficOptions.Builderavoiding the need to create one manually viaIsolineTrafficOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totraffic(IsolineTrafficOptions).- Parameters:
traffic- a consumer that will call methods onIsolineTrafficOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelMode
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The mode
Scooteralso applies to motorcycles, set toScooterwhen wanted to calculate options for motorcycles.Default Value:
Car- Parameters:
travelMode- Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.The mode
Scooteralso applies to motorcycles, set toScooterwhen wanted to calculate options for motorcycles.Default Value:
Car- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelMode
Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.
The mode
Scooteralso applies to motorcycles, set toScooterwhen wanted to calculate options for motorcycles.Default Value:
Car- Parameters:
travelMode- Specifies the mode of transport when calculating a route. Used in estimating the speed of travel and road compatibility.The mode
Scooteralso applies to motorcycles, set toScooterwhen wanted to calculate options for motorcycles.Default Value:
Car- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
travelModeOptions
Travel mode related options for the provided travel mode.
- Parameters:
travelModeOptions- Travel mode related options for the provided travel mode.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
travelModeOptions
default CalculateIsolinesRequest.Builder travelModeOptions(Consumer<IsolineTravelModeOptions.Builder> travelModeOptions) Travel mode related options for the provided travel mode.
This is a convenience method that creates an instance of theIsolineTravelModeOptions.Builderavoiding the need to create one manually viaIsolineTravelModeOptions.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed totravelModeOptions(IsolineTravelModeOptions).- Parameters:
travelModeOptions- a consumer that will call methods onIsolineTravelModeOptions.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CalculateIsolinesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CalculateIsolinesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-