Interface CreateRouteCalculatorRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateRouteCalculatorRequest.Builder,
,CreateRouteCalculatorRequest> LocationRequest.Builder
,SdkBuilder<CreateRouteCalculatorRequest.Builder,
,CreateRouteCalculatorRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateRouteCalculatorRequest
-
Method Summary
Modifier and TypeMethodDescriptioncalculatorName
(String calculatorName) The name of the route calculator resource.dataSource
(String dataSource) Specifies the data provider of traffic and road network data.description
(String description) The optional description for the route calculator resource.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.pricingPlan
(String pricingPlan) Deprecated.Deprecated.pricingPlan
(PricingPlan pricingPlan) Deprecated.Deprecated.Applies one or more tags to the route calculator resource.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
calculatorName
The name of the route calculator resource.
Requirements:
-
Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
-
Must be a unique Route calculator resource name.
-
No spaces allowed. For example,
ExampleRouteCalculator
.
- Parameters:
calculatorName
- The name of the route calculator resource.Requirements:
-
Can use alphanumeric characters (A–Z, a–z, 0–9) , hyphens (-), periods (.), and underscores (_).
-
Must be a unique Route calculator resource name.
-
No spaces allowed. For example,
ExampleRouteCalculator
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dataSource
Specifies the data provider of traffic and road network data.
This field is case-sensitive. Enter the valid values as shown. For example, entering
HERE
returns an error.Valid values include:
-
Esri
– For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
-
Grab
– Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered. -
Here
– For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
- Parameters:
dataSource
- Specifies the data provider of traffic and road network data.This field is case-sensitive. Enter the valid values as shown. For example, entering
HERE
returns an error.Valid values include:
-
Esri
– For additional information about Esri's coverage in your region of interest, see Esri details on street networks and traffic coverage.Route calculators that use Esri as a data source only calculate routes that are shorter than 400 km.
-
Grab
– Grab provides routing functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered. -
Here
– For additional information about HERE Technologies' coverage in your region of interest, see HERE car routing coverage and HERE truck routing coverage.
For additional information , see Data providers on the Amazon Location Service Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
description
The optional description for the route calculator resource.
- Parameters:
description
- The optional description for the route calculator resource.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pricingPlan
Deprecated.Deprecated. If included, the only allowed value is RequestBasedUsage.No longer used. If included, the only allowed value is
RequestBasedUsage
.- Parameters:
pricingPlan
- No longer used. If included, the only allowed value isRequestBasedUsage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
pricingPlan
Deprecated.Deprecated. If included, the only allowed value is RequestBasedUsage.No longer used. If included, the only allowed value is
RequestBasedUsage
.- Parameters:
pricingPlan
- No longer used. If included, the only allowed value isRequestBasedUsage
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.
-
For example: {
"tag1" : "value1"
,"tag2" : "value2"
Format:
"key" : "value"
Restrictions:
-
Maximum 50 tags per resource
-
Each resource tag must be unique with a maximum of one value.
-
Maximum key length: 128 Unicode characters in UTF-8
-
Maximum value length: 256 Unicode characters in UTF-8
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
-
Cannot use "aws:" as a prefix for a key.
- Parameters:
tags
- Applies one or more tags to the route calculator resource. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.-
For example: {
"tag1" : "value1"
,"tag2" : "value2"
Format:
"key" : "value"
Restrictions:
-
Maximum 50 tags per resource
-
Each resource tag must be unique with a maximum of one value.
-
Maximum key length: 128 Unicode characters in UTF-8
-
Maximum value length: 256 Unicode characters in UTF-8
-
Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.
-
Cannot use "aws:" as a prefix for a key.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CreateRouteCalculatorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateRouteCalculatorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-