CalculateRouteTruckModeOptions (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.location.model.CalculateRouteTruckModeOptions

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CalculateRouteTruckModeOptions
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains details about additional route preferences for requests that specify TravelMode as Truck.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CalculateRouteTruckModeOptions()

Constructors
Constructor and Description
`CalculateRouteTruckModeOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CalculateRouteTruckModeOptions`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getAvoidFerries()` Avoids ferries when calculating routes.
`Boolean`	`getAvoidTolls()` Avoids ferries when calculating routes.
`TruckDimensions`	`getDimensions()` Specifies the truck's dimension specifications including length, height, width, and unit of measurement.
`TruckWeight`	`getWeight()` Specifies the truck's weight specifications including total weight and unit of measurement.
`int`	`hashCode()`
`Boolean`	`isAvoidFerries()` Avoids ferries when calculating routes.
`Boolean`	`isAvoidTolls()` Avoids ferries when calculating routes.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvoidFerries(Boolean avoidFerries)` Avoids ferries when calculating routes.
`void`	`setAvoidTolls(Boolean avoidTolls)` Avoids ferries when calculating routes.
`void`	`setDimensions(TruckDimensions dimensions)` Specifies the truck's dimension specifications including length, height, width, and unit of measurement.
`void`	`setWeight(TruckWeight weight)` Specifies the truck's weight specifications including total weight and unit of measurement.
`String`	`toString()` Returns a string representation of this object.
`CalculateRouteTruckModeOptions`	`withAvoidFerries(Boolean avoidFerries)` Avoids ferries when calculating routes.
`CalculateRouteTruckModeOptions`	`withAvoidTolls(Boolean avoidTolls)` Avoids ferries when calculating routes.
`CalculateRouteTruckModeOptions`	`withDimensions(TruckDimensions dimensions)` Specifies the truck's dimension specifications including length, height, width, and unit of measurement.
`CalculateRouteTruckModeOptions`	`withWeight(TruckWeight weight)` Specifies the truck's weight specifications including total weight and unit of measurement.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CalculateRouteTruckModeOptions
```
public CalculateRouteTruckModeOptions()
```
- Method Detail
  - setAvoidFerries
```
public void setAvoidFerries(Boolean avoidFerries)
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Parameters:
    
    avoidFerries - Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - getAvoidFerries
```
public Boolean getAvoidFerries()
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - withAvoidFerries
```
public CalculateRouteTruckModeOptions withAvoidFerries(Boolean avoidFerries)
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Parameters:
    
    avoidFerries - Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAvoidFerries
```
public Boolean isAvoidFerries()
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - setAvoidTolls
```
public void setAvoidTolls(Boolean avoidTolls)
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Parameters:
    
    avoidTolls - Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - getAvoidTolls
```
public Boolean getAvoidTolls()
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - withAvoidTolls
```
public CalculateRouteTruckModeOptions withAvoidTolls(Boolean avoidTolls)
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Parameters:
    
    avoidTolls - Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAvoidTolls
```
public Boolean isAvoidTolls()
```
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
    
    Returns:
    
    Avoids ferries when calculating routes.
    
    Default Value: false
    
    Valid Values: false | true
  - setDimensions
```
public void setDimensions(TruckDimensions dimensions)
```
    Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
    
    Parameters:
    
    dimensions - Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
  - getDimensions
```
public TruckDimensions getDimensions()
```
    Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
    
    Returns:
    
    Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
  - withDimensions
```
public CalculateRouteTruckModeOptions withDimensions(TruckDimensions dimensions)
```
    Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
    
    Parameters:
    
    dimensions - Specifies the truck's dimension specifications including length, height, width, and unit of measurement. Used to avoid roads that can't support the truck's dimensions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWeight
```
public void setWeight(TruckWeight weight)
```
    Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
    
    Parameters:
    
    weight - Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
  - getWeight
```
public TruckWeight getWeight()
```
    Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
    
    Returns:
    
    Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
  - withWeight
```
public CalculateRouteTruckModeOptions withWeight(TruckWeight weight)
```
    Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
    
    Parameters:
    
    weight - Specifies the truck's weight specifications including total weight and unit of measurement. Used to avoid roads that can't support the truck's weight.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CalculateRouteTruckModeOptions clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CalculateRouteTruckModeOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CalculateRouteTruckModeOptions

Method Detail

setAvoidFerries

getAvoidFerries

withAvoidFerries

isAvoidFerries

setAvoidTolls

getAvoidTolls

withAvoidTolls

isAvoidTolls

setDimensions

getDimensions

withDimensions

setWeight

getWeight

withWeight

toString

equals

hashCode

clone

marshall