com.amazonaws.services.location.model.CalculateRouteTruckModeOptions Maven / Gradle / Ivy
Show all versions of aws-java-sdk-location Show documentation
/*
* Copyright 2019-2024 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details about additional route preferences for requests that specify TravelMode as
* Truck.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CalculateRouteTruckModeOptions implements Serializable, Cloneable, StructuredPojo {
/**
*
* Avoids ferries when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*/
private Boolean avoidFerries;
/**
*
* Avoids tolls when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*/
private Boolean avoidTolls;
/**
*
* 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.
*
*/
private TruckDimensions dimensions;
/**
*
* 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.
*
*/
private TruckWeight weight;
/**
*
* Avoids ferries when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @param avoidFerries
* Avoids ferries when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public void setAvoidFerries(Boolean avoidFerries) {
this.avoidFerries = avoidFerries;
}
/**
*
* Avoids ferries when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @return Avoids ferries when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public Boolean getAvoidFerries() {
return this.avoidFerries;
}
/**
*
* Avoids ferries when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @param avoidFerries
* Avoids ferries when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteTruckModeOptions withAvoidFerries(Boolean avoidFerries) {
setAvoidFerries(avoidFerries);
return this;
}
/**
*
* Avoids ferries when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @return Avoids ferries when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public Boolean isAvoidFerries() {
return this.avoidFerries;
}
/**
*
* Avoids tolls when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @param avoidTolls
* Avoids tolls when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public void setAvoidTolls(Boolean avoidTolls) {
this.avoidTolls = avoidTolls;
}
/**
*
* Avoids tolls when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @return Avoids tolls when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public Boolean getAvoidTolls() {
return this.avoidTolls;
}
/**
*
* Avoids tolls when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @param avoidTolls
* Avoids tolls when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteTruckModeOptions withAvoidTolls(Boolean avoidTolls) {
setAvoidTolls(avoidTolls);
return this;
}
/**
*
* Avoids tolls when calculating routes.
*
*
* Default Value: false
*
*
* Valid Values: false | true
*
*
* @return Avoids tolls when calculating routes.
*
* Default Value: false
*
*
* Valid Values: false | true
*/
public Boolean isAvoidTolls() {
return this.avoidTolls;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setDimensions(TruckDimensions dimensions) {
this.dimensions = 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.
*
*
* @return 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.
*/
public TruckDimensions getDimensions() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteTruckModeOptions withDimensions(TruckDimensions dimensions) {
setDimensions(dimensions);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setWeight(TruckWeight weight) {
this.weight = 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.
*
*
* @return 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.
*/
public TruckWeight getWeight() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CalculateRouteTruckModeOptions withWeight(TruckWeight weight) {
setWeight(weight);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAvoidFerries() != null)
sb.append("AvoidFerries: ").append(getAvoidFerries()).append(",");
if (getAvoidTolls() != null)
sb.append("AvoidTolls: ").append(getAvoidTolls()).append(",");
if (getDimensions() != null)
sb.append("Dimensions: ").append(getDimensions()).append(",");
if (getWeight() != null)
sb.append("Weight: ").append(getWeight());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CalculateRouteTruckModeOptions == false)
return false;
CalculateRouteTruckModeOptions other = (CalculateRouteTruckModeOptions) obj;
if (other.getAvoidFerries() == null ^ this.getAvoidFerries() == null)
return false;
if (other.getAvoidFerries() != null && other.getAvoidFerries().equals(this.getAvoidFerries()) == false)
return false;
if (other.getAvoidTolls() == null ^ this.getAvoidTolls() == null)
return false;
if (other.getAvoidTolls() != null && other.getAvoidTolls().equals(this.getAvoidTolls()) == false)
return false;
if (other.getDimensions() == null ^ this.getDimensions() == null)
return false;
if (other.getDimensions() != null && other.getDimensions().equals(this.getDimensions()) == false)
return false;
if (other.getWeight() == null ^ this.getWeight() == null)
return false;
if (other.getWeight() != null && other.getWeight().equals(this.getWeight()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAvoidFerries() == null) ? 0 : getAvoidFerries().hashCode());
hashCode = prime * hashCode + ((getAvoidTolls() == null) ? 0 : getAvoidTolls().hashCode());
hashCode = prime * hashCode + ((getDimensions() == null) ? 0 : getDimensions().hashCode());
hashCode = prime * hashCode + ((getWeight() == null) ? 0 : getWeight().hashCode());
return hashCode;
}
@Override
public CalculateRouteTruckModeOptions clone() {
try {
return (CalculateRouteTruckModeOptions) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.location.model.transform.CalculateRouteTruckModeOptionsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}