/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.location.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateRouteCalculatorRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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
.
*
* 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. *
*/ private String dataSource; /** ** The optional description for the route calculator resource. *
*/ private String description; /** *
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
* 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. *
** 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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
.
*
* 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. *
* * @param 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. */ public void setDataSource(String dataSource) { this.dataSource = 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. *
* * @return 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. */ public String getDataSource() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateRouteCalculatorRequest withDataSource(String dataSource) { setDataSource(dataSource); return this; } /** *
* The optional description for the route calculator resource. *
* * @param description * The optional description for the route calculator resource. */ public void setDescription(String description) { this.description = description; } /** ** The optional description for the route calculator resource. *
* * @return The optional description for the route calculator resource. */ public String getDescription() { return this.description; } /** ** The optional description for the route calculator resource. *
* * @param description * The optional description for the route calculator resource. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateRouteCalculatorRequest withDescription(String description) { setDescription(description); return this; } /** *
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @see PricingPlan
*/
@Deprecated
public void setPricingPlan(String pricingPlan) {
this.pricingPlan = pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @see PricingPlan
*/
@Deprecated
public String getPricingPlan() {
return this.pricingPlan;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateRouteCalculatorRequest withPricingPlan(String pricingPlan) {
setPricingPlan(pricingPlan);
return this;
}
/**
*
* No longer used. If included, the only allowed value is RequestBasedUsage
.
*
RequestBasedUsage
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PricingPlan
*/
@Deprecated
public CreateRouteCalculatorRequest withPricingPlan(PricingPlan pricingPlan) {
this.pricingPlan = pricingPlan.toString();
return this;
}
/**
* * 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. *
*
* 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. *
** 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. *
*
* 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. *
** 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. *
*
* 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. *
*