| Name | Type | Description | Notes |
|---|---|---|---|
| Points | Pointer to [][]float64 | The points for the route in an array of `[longitude,latitude]`. For instance, if you want to calculate a route from point A to B to C then you specify `points: [ [A_longitude, A_latitude], [B_longitude, B_latitude], [C_longitude, C_latitude]] | [optional] |
| PointHints | Pointer to []string | Optional parameter. Specifies a hint for each point in the `points` array to prefer a certain street for the closest location lookup. E.g. if there is an address or house with two or more neighboring streets you can control for which street the closest location is looked up. | [optional] |
| SnapPreventions | Pointer to []string | Optional parameter to avoid snapping to a certain road class or road environment. Current supported values `motorway`, `trunk`, `ferry`, `tunnel`, `bridge` and `ford` | [optional] |
| Curbsides | Pointer to []string | Optional parameter. It specifies on which side a point should be relative to the driver when she leaves/arrives at a start/target/via point. You need to specify this parameter for either none or all points. Only supported for motor vehicles and OpenStreetMap. | [optional] |
| Vehicle | Pointer to VehicleProfileId | [optional] | |
| Locale | Pointer to string | The locale of the resulting turn instructions. E.g. `pt_PT` for Portuguese or `de` for German. | [optional] [default to "en"] |
| Elevation | Pointer to bool | If `true`, a third coordinate, the altitude, is included with all positions in the response. This changes the format of the `points` and `snapped_waypoints` fields of the response, in both their encodings. Unless you switch off the `points_encoded` parameter, you need special code on the client side that can handle three-dimensional coordinates. A request can fail if the vehicle profile does not support elevation. See the features object for every vehicle profile. | [optional] [default to false] |
| Details | Pointer to []string | Optional parameter to retrieve path details. You can request additional details for the route: `street_name`, `time`, `distance`, `max_speed`, `toll`, `road_class`, `road_class_link`, `road_access`, `road_environment`, `lanes`, and `surface`. Read more about the usage of path details here. | [optional] |
| Optimize | Pointer to string | Normally, the calculated route will visit the points in the order you specified them. If you have more than two points, you can set this parameter to `"true"` and the points may be re-ordered to minimize the total travel time. Keep in mind that the limits on the number of locations of the Route Optimization API applies, and the request costs more credits. | [optional] [default to "false"] |
| Instructions | Pointer to bool | If instructions should be calculated and returned | [optional] [default to true] |
| CalcPoints | Pointer to bool | If the points for the route should be calculated at all. | [optional] [default to true] |
| Debug | Pointer to bool | If `true`, the output will be formatted. | [optional] [default to false] |
| PointsEncoded | Pointer to bool | Allows changing the encoding of location data in the response. The default is polyline encoding, which is compact but requires special client code to unpack. (We provide it in our JavaScript client library!) Set this parameter to `false` to switch the encoding to simple coordinate pairs like `[lon,lat]`, or `[lon,lat,elevation]`. See the description of the response format for more information. | [optional] [default to true] |
| ChDisable | Pointer to bool | Use this parameter in combination with one or more parameters from below. | [optional] [default to false] |
| Weighting | Pointer to string | Determines the way the ''best'' route is calculated. Default is `fastest`. Other options are `shortest` (e.g. for `vehicle=foot` or `bike`) and `short_fastest` which finds a reasonable balance between `shortest` and `fastest`. Requires `ch.disable=true`. | [optional] [default to "fastest"] |
| Headings | Pointer to []int32 | Favour a heading direction for a certain point. Specify either one heading for the start point or as many as there are points. In this case headings are associated by their order to the specific points. Headings are given as north based clockwise angle between 0 and 360 degree. This parameter also influences the tour generated with `algorithm=round_trip` and forces the initial direction. Requires `ch.disable=true`. | [optional] |
| HeadingPenalty | Pointer to int32 | Time penalty in seconds for not obeying a specified heading. Requires `ch.disable=true`. | [optional] [default to 120] |
| PassThrough | Pointer to bool | If `true`, u-turns are avoided at via-points with regard to the `heading_penalty`. Requires `ch.disable=true`. | [optional] [default to false] |
| BlockArea | Pointer to string | Block road access via a point with the format `latitude,longitude` or an area defined by a circle `lat,lon,radius` or a rectangle `lat1,lon1,lat2,lon2`. Separate several values with `;`. Requires `ch.disable=true`. | [optional] |
| Avoid | Pointer to string | Specify which road classes and environments you would like to avoid. Possible values are `motorway`, `steps`, `track`, `toll`, `ferry`, `tunnel` and `bridge`. Separate several values with `;`. Obviously not all the values make sense for all vehicle profiles e.g. `bike` is already forbidden on a `motorway`. Requires `ch.disable=true`. | [optional] |
| Algorithm | Pointer to string | Rather than looking for the shortest or fastest path, this lets you solve two different problems related to routing: With `round_trip`, the route will get you back to where you started. This is meant for fun (think of a bike trip), so we will add some randomness. This requires `ch.disable=true`. With `alternative_route`, we give you not one but several routes that are close to optimal, but not too similar to each other. You can control both of these features with additional parameters, see below. | [optional] |
| RoundTripDistance | Pointer to int32 | If `algorithm=round_trip`, this parameter configures approximative length of the resulting round trip. Requires `ch.disable=true`. | [optional] [default to 10000] |
| RoundTripSeed | Pointer to int64 | If `algorithm=round_trip`, this sets the random seed. Change this to get a different tour for each value. | [optional] |
| AlternativeRouteMaxPaths | Pointer to int32 | If `algorithm=alternative_route`, this parameter sets the number of maximum paths which should be calculated. Increasing can lead to worse alternatives. | [optional] [default to 2] |
| AlternativeRouteMaxWeightFactor | Pointer to float32 | If `algorithm=alternative_route`, this parameter sets the factor by which the alternatives routes can be longer than the optimal route. Increasing can lead to worse alternatives. | [optional] [default to 1.4] |
| AlternativeRouteMaxShareFactor | Pointer to float32 | If `algorithm=alternative_route`, this parameter specifies how similar an alternative route can be to the optimal route. Increasing can lead to worse alternatives. | [optional] [default to 0.6] |
func NewRouteRequest() *RouteRequest
NewRouteRequest instantiates a new RouteRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed
func NewRouteRequestWithDefaults() *RouteRequest
NewRouteRequestWithDefaults instantiates a new RouteRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set
func (o *RouteRequest) GetPoints() [][]float64
GetPoints returns the Points field if non-nil, zero value otherwise.
func (o *RouteRequest) GetPointsOk() (*[][]float64, bool)
GetPointsOk returns a tuple with the Points field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetPoints(v [][]float64)
SetPoints sets Points field to given value.
func (o *RouteRequest) HasPoints() bool
HasPoints returns a boolean if a field has been set.
func (o *RouteRequest) GetPointHints() []string
GetPointHints returns the PointHints field if non-nil, zero value otherwise.
func (o *RouteRequest) GetPointHintsOk() (*[]string, bool)
GetPointHintsOk returns a tuple with the PointHints field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetPointHints(v []string)
SetPointHints sets PointHints field to given value.
func (o *RouteRequest) HasPointHints() bool
HasPointHints returns a boolean if a field has been set.
func (o *RouteRequest) GetSnapPreventions() []string
GetSnapPreventions returns the SnapPreventions field if non-nil, zero value otherwise.
func (o *RouteRequest) GetSnapPreventionsOk() (*[]string, bool)
GetSnapPreventionsOk returns a tuple with the SnapPreventions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetSnapPreventions(v []string)
SetSnapPreventions sets SnapPreventions field to given value.
func (o *RouteRequest) HasSnapPreventions() bool
HasSnapPreventions returns a boolean if a field has been set.
func (o *RouteRequest) GetCurbsides() []string
GetCurbsides returns the Curbsides field if non-nil, zero value otherwise.
func (o *RouteRequest) GetCurbsidesOk() (*[]string, bool)
GetCurbsidesOk returns a tuple with the Curbsides field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetCurbsides(v []string)
SetCurbsides sets Curbsides field to given value.
func (o *RouteRequest) HasCurbsides() bool
HasCurbsides returns a boolean if a field has been set.
func (o *RouteRequest) GetVehicle() VehicleProfileId
GetVehicle returns the Vehicle field if non-nil, zero value otherwise.
func (o *RouteRequest) GetVehicleOk() (*VehicleProfileId, bool)
GetVehicleOk returns a tuple with the Vehicle field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetVehicle(v VehicleProfileId)
SetVehicle sets Vehicle field to given value.
func (o *RouteRequest) HasVehicle() bool
HasVehicle returns a boolean if a field has been set.
func (o *RouteRequest) GetLocale() string
GetLocale returns the Locale field if non-nil, zero value otherwise.
func (o *RouteRequest) GetLocaleOk() (*string, bool)
GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetLocale(v string)
SetLocale sets Locale field to given value.
func (o *RouteRequest) HasLocale() bool
HasLocale returns a boolean if a field has been set.
func (o *RouteRequest) GetElevation() bool
GetElevation returns the Elevation field if non-nil, zero value otherwise.
func (o *RouteRequest) GetElevationOk() (*bool, bool)
GetElevationOk returns a tuple with the Elevation field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetElevation(v bool)
SetElevation sets Elevation field to given value.
func (o *RouteRequest) HasElevation() bool
HasElevation returns a boolean if a field has been set.
func (o *RouteRequest) GetDetails() []string
GetDetails returns the Details field if non-nil, zero value otherwise.
func (o *RouteRequest) GetDetailsOk() (*[]string, bool)
GetDetailsOk returns a tuple with the Details field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetDetails(v []string)
SetDetails sets Details field to given value.
func (o *RouteRequest) HasDetails() bool
HasDetails returns a boolean if a field has been set.
func (o *RouteRequest) GetOptimize() string
GetOptimize returns the Optimize field if non-nil, zero value otherwise.
func (o *RouteRequest) GetOptimizeOk() (*string, bool)
GetOptimizeOk returns a tuple with the Optimize field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetOptimize(v string)
SetOptimize sets Optimize field to given value.
func (o *RouteRequest) HasOptimize() bool
HasOptimize returns a boolean if a field has been set.
func (o *RouteRequest) GetInstructions() bool
GetInstructions returns the Instructions field if non-nil, zero value otherwise.
func (o *RouteRequest) GetInstructionsOk() (*bool, bool)
GetInstructionsOk returns a tuple with the Instructions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetInstructions(v bool)
SetInstructions sets Instructions field to given value.
func (o *RouteRequest) HasInstructions() bool
HasInstructions returns a boolean if a field has been set.
func (o *RouteRequest) GetCalcPoints() bool
GetCalcPoints returns the CalcPoints field if non-nil, zero value otherwise.
func (o *RouteRequest) GetCalcPointsOk() (*bool, bool)
GetCalcPointsOk returns a tuple with the CalcPoints field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetCalcPoints(v bool)
SetCalcPoints sets CalcPoints field to given value.
func (o *RouteRequest) HasCalcPoints() bool
HasCalcPoints returns a boolean if a field has been set.
func (o *RouteRequest) GetDebug() bool
GetDebug returns the Debug field if non-nil, zero value otherwise.
func (o *RouteRequest) GetDebugOk() (*bool, bool)
GetDebugOk returns a tuple with the Debug field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetDebug(v bool)
SetDebug sets Debug field to given value.
func (o *RouteRequest) HasDebug() bool
HasDebug returns a boolean if a field has been set.
func (o *RouteRequest) GetPointsEncoded() bool
GetPointsEncoded returns the PointsEncoded field if non-nil, zero value otherwise.
func (o *RouteRequest) GetPointsEncodedOk() (*bool, bool)
GetPointsEncodedOk returns a tuple with the PointsEncoded field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetPointsEncoded(v bool)
SetPointsEncoded sets PointsEncoded field to given value.
func (o *RouteRequest) HasPointsEncoded() bool
HasPointsEncoded returns a boolean if a field has been set.
func (o *RouteRequest) GetChDisable() bool
GetChDisable returns the ChDisable field if non-nil, zero value otherwise.
func (o *RouteRequest) GetChDisableOk() (*bool, bool)
GetChDisableOk returns a tuple with the ChDisable field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetChDisable(v bool)
SetChDisable sets ChDisable field to given value.
func (o *RouteRequest) HasChDisable() bool
HasChDisable returns a boolean if a field has been set.
func (o *RouteRequest) GetWeighting() string
GetWeighting returns the Weighting field if non-nil, zero value otherwise.
func (o *RouteRequest) GetWeightingOk() (*string, bool)
GetWeightingOk returns a tuple with the Weighting field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetWeighting(v string)
SetWeighting sets Weighting field to given value.
func (o *RouteRequest) HasWeighting() bool
HasWeighting returns a boolean if a field has been set.
func (o *RouteRequest) GetHeadings() []int32
GetHeadings returns the Headings field if non-nil, zero value otherwise.
func (o *RouteRequest) GetHeadingsOk() (*[]int32, bool)
GetHeadingsOk returns a tuple with the Headings field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetHeadings(v []int32)
SetHeadings sets Headings field to given value.
func (o *RouteRequest) HasHeadings() bool
HasHeadings returns a boolean if a field has been set.
func (o *RouteRequest) GetHeadingPenalty() int32
GetHeadingPenalty returns the HeadingPenalty field if non-nil, zero value otherwise.
func (o *RouteRequest) GetHeadingPenaltyOk() (*int32, bool)
GetHeadingPenaltyOk returns a tuple with the HeadingPenalty field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetHeadingPenalty(v int32)
SetHeadingPenalty sets HeadingPenalty field to given value.
func (o *RouteRequest) HasHeadingPenalty() bool
HasHeadingPenalty returns a boolean if a field has been set.
func (o *RouteRequest) GetPassThrough() bool
GetPassThrough returns the PassThrough field if non-nil, zero value otherwise.
func (o *RouteRequest) GetPassThroughOk() (*bool, bool)
GetPassThroughOk returns a tuple with the PassThrough field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetPassThrough(v bool)
SetPassThrough sets PassThrough field to given value.
func (o *RouteRequest) HasPassThrough() bool
HasPassThrough returns a boolean if a field has been set.
func (o *RouteRequest) GetBlockArea() string
GetBlockArea returns the BlockArea field if non-nil, zero value otherwise.
func (o *RouteRequest) GetBlockAreaOk() (*string, bool)
GetBlockAreaOk returns a tuple with the BlockArea field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetBlockArea(v string)
SetBlockArea sets BlockArea field to given value.
func (o *RouteRequest) HasBlockArea() bool
HasBlockArea returns a boolean if a field has been set.
func (o *RouteRequest) GetAvoid() string
GetAvoid returns the Avoid field if non-nil, zero value otherwise.
func (o *RouteRequest) GetAvoidOk() (*string, bool)
GetAvoidOk returns a tuple with the Avoid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetAvoid(v string)
SetAvoid sets Avoid field to given value.
func (o *RouteRequest) HasAvoid() bool
HasAvoid returns a boolean if a field has been set.
func (o *RouteRequest) GetAlgorithm() string
GetAlgorithm returns the Algorithm field if non-nil, zero value otherwise.
func (o *RouteRequest) GetAlgorithmOk() (*string, bool)
GetAlgorithmOk returns a tuple with the Algorithm field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetAlgorithm(v string)
SetAlgorithm sets Algorithm field to given value.
func (o *RouteRequest) HasAlgorithm() bool
HasAlgorithm returns a boolean if a field has been set.
func (o *RouteRequest) GetRoundTripDistance() int32
GetRoundTripDistance returns the RoundTripDistance field if non-nil, zero value otherwise.
func (o *RouteRequest) GetRoundTripDistanceOk() (*int32, bool)
GetRoundTripDistanceOk returns a tuple with the RoundTripDistance field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetRoundTripDistance(v int32)
SetRoundTripDistance sets RoundTripDistance field to given value.
func (o *RouteRequest) HasRoundTripDistance() bool
HasRoundTripDistance returns a boolean if a field has been set.
func (o *RouteRequest) GetRoundTripSeed() int64
GetRoundTripSeed returns the RoundTripSeed field if non-nil, zero value otherwise.
func (o *RouteRequest) GetRoundTripSeedOk() (*int64, bool)
GetRoundTripSeedOk returns a tuple with the RoundTripSeed field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetRoundTripSeed(v int64)
SetRoundTripSeed sets RoundTripSeed field to given value.
func (o *RouteRequest) HasRoundTripSeed() bool
HasRoundTripSeed returns a boolean if a field has been set.
func (o *RouteRequest) GetAlternativeRouteMaxPaths() int32
GetAlternativeRouteMaxPaths returns the AlternativeRouteMaxPaths field if non-nil, zero value otherwise.
func (o *RouteRequest) GetAlternativeRouteMaxPathsOk() (*int32, bool)
GetAlternativeRouteMaxPathsOk returns a tuple with the AlternativeRouteMaxPaths field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetAlternativeRouteMaxPaths(v int32)
SetAlternativeRouteMaxPaths sets AlternativeRouteMaxPaths field to given value.
func (o *RouteRequest) HasAlternativeRouteMaxPaths() bool
HasAlternativeRouteMaxPaths returns a boolean if a field has been set.
func (o *RouteRequest) GetAlternativeRouteMaxWeightFactor() float32
GetAlternativeRouteMaxWeightFactor returns the AlternativeRouteMaxWeightFactor field if non-nil, zero value otherwise.
func (o *RouteRequest) GetAlternativeRouteMaxWeightFactorOk() (*float32, bool)
GetAlternativeRouteMaxWeightFactorOk returns a tuple with the AlternativeRouteMaxWeightFactor field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetAlternativeRouteMaxWeightFactor(v float32)
SetAlternativeRouteMaxWeightFactor sets AlternativeRouteMaxWeightFactor field to given value.
func (o *RouteRequest) HasAlternativeRouteMaxWeightFactor() bool
HasAlternativeRouteMaxWeightFactor returns a boolean if a field has been set.
func (o *RouteRequest) GetAlternativeRouteMaxShareFactor() float32
GetAlternativeRouteMaxShareFactor returns the AlternativeRouteMaxShareFactor field if non-nil, zero value otherwise.
func (o *RouteRequest) GetAlternativeRouteMaxShareFactorOk() (*float32, bool)
GetAlternativeRouteMaxShareFactorOk returns a tuple with the AlternativeRouteMaxShareFactor field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
func (o *RouteRequest) SetAlternativeRouteMaxShareFactor(v float32)
SetAlternativeRouteMaxShareFactor sets AlternativeRouteMaxShareFactor field to given value.
func (o *RouteRequest) HasAlternativeRouteMaxShareFactor() bool
HasAlternativeRouteMaxShareFactor returns a boolean if a field has been set.