Class Vehicle.LoadLimit.Builder (1.44.0)

public static final class Vehicle.LoadLimit.Builder extends GeneratedMessageV3.Builder<Vehicle.LoadLimit.Builder> implements Vehicle.LoadLimitOrBuilder

Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See load_limits.

Protobuf type google.cloud.optimization.v1.Vehicle.LoadLimit

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Vehicle.LoadLimit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

build()

public Vehicle.LoadLimit build()
Returns
Type Description
Vehicle.LoadLimit

buildPartial()

public Vehicle.LoadLimit buildPartial()
Returns
Type Description
Vehicle.LoadLimit

clear()

public Vehicle.LoadLimit.Builder clear()
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

clearCostPerUnitAboveSoftMax()

public Vehicle.LoadLimit.Builder clearCostPerUnitAboveSoftMax()

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load)

  • cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost.

double cost_per_unit_above_soft_max = 3;

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

clearEndLoadInterval()

public Vehicle.LoadLimit.Builder clearEndLoadInterval()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
Type Description
Vehicle.LoadLimit.Builder

clearField(Descriptors.FieldDescriptor field)

public Vehicle.LoadLimit.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

clearMaxLoad()

public Vehicle.LoadLimit.Builder clearMaxLoad()

The maximum acceptable amount of load.

optional int64 max_load = 1;

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Vehicle.LoadLimit.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

clearSoftMaxLoad()

public Vehicle.LoadLimit.Builder clearSoftMaxLoad()

A soft limit of the load. See cost_per_unit_above_soft_max.

int64 soft_max_load = 2;

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

clearStartLoadInterval()

public Vehicle.LoadLimit.Builder clearStartLoadInterval()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
Type Description
Vehicle.LoadLimit.Builder

clone()

public Vehicle.LoadLimit.Builder clone()
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

getCostPerUnitAboveSoftMax()

public double getCostPerUnitAboveSoftMax()

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load)

  • cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost.

double cost_per_unit_above_soft_max = 3;

Returns
Type Description
double

The costPerUnitAboveSoftMax.

getDefaultInstanceForType()

public Vehicle.LoadLimit getDefaultInstanceForType()
Returns
Type Description
Vehicle.LoadLimit

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndLoadInterval()

public Vehicle.LoadLimit.Interval getEndLoadInterval()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
Type Description
Vehicle.LoadLimit.Interval

The endLoadInterval.

getEndLoadIntervalBuilder()

public Vehicle.LoadLimit.Interval.Builder getEndLoadIntervalBuilder()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
Type Description
Vehicle.LoadLimit.Interval.Builder

getEndLoadIntervalOrBuilder()

public Vehicle.LoadLimit.IntervalOrBuilder getEndLoadIntervalOrBuilder()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
Type Description
Vehicle.LoadLimit.IntervalOrBuilder

getMaxLoad()

public long getMaxLoad()

The maximum acceptable amount of load.

optional int64 max_load = 1;

Returns
Type Description
long

The maxLoad.

getSoftMaxLoad()

public long getSoftMaxLoad()

A soft limit of the load. See cost_per_unit_above_soft_max.

int64 soft_max_load = 2;

Returns
Type Description
long

The softMaxLoad.

getStartLoadInterval()

public Vehicle.LoadLimit.Interval getStartLoadInterval()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
Type Description
Vehicle.LoadLimit.Interval

The startLoadInterval.

getStartLoadIntervalBuilder()

public Vehicle.LoadLimit.Interval.Builder getStartLoadIntervalBuilder()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
Type Description
Vehicle.LoadLimit.Interval.Builder

getStartLoadIntervalOrBuilder()

public Vehicle.LoadLimit.IntervalOrBuilder getStartLoadIntervalOrBuilder()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
Type Description
Vehicle.LoadLimit.IntervalOrBuilder

hasEndLoadInterval()

public boolean hasEndLoadInterval()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
Type Description
boolean

Whether the endLoadInterval field is set.

hasMaxLoad()

public boolean hasMaxLoad()

The maximum acceptable amount of load.

optional int64 max_load = 1;

Returns
Type Description
boolean

Whether the maxLoad field is set.

hasStartLoadInterval()

public boolean hasStartLoadInterval()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
Type Description
boolean

Whether the startLoadInterval field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndLoadInterval(Vehicle.LoadLimit.Interval value)

public Vehicle.LoadLimit.Builder mergeEndLoadInterval(Vehicle.LoadLimit.Interval value)

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Parameter
Name Description
value Vehicle.LoadLimit.Interval
Returns
Type Description
Vehicle.LoadLimit.Builder

mergeFrom(Vehicle.LoadLimit other)

public Vehicle.LoadLimit.Builder mergeFrom(Vehicle.LoadLimit other)
Parameter
Name Description
other Vehicle.LoadLimit
Returns
Type Description
Vehicle.LoadLimit.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Vehicle.LoadLimit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Vehicle.LoadLimit.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

mergeStartLoadInterval(Vehicle.LoadLimit.Interval value)

public Vehicle.LoadLimit.Builder mergeStartLoadInterval(Vehicle.LoadLimit.Interval value)

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Parameter
Name Description
value Vehicle.LoadLimit.Interval
Returns
Type Description
Vehicle.LoadLimit.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Vehicle.LoadLimit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

setCostPerUnitAboveSoftMax(double value)

public Vehicle.LoadLimit.Builder setCostPerUnitAboveSoftMax(double value)

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load)

  • cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost.

double cost_per_unit_above_soft_max = 3;

Parameter
Name Description
value double

The costPerUnitAboveSoftMax to set.

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

setEndLoadInterval(Vehicle.LoadLimit.Interval value)

public Vehicle.LoadLimit.Builder setEndLoadInterval(Vehicle.LoadLimit.Interval value)

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Parameter
Name Description
value Vehicle.LoadLimit.Interval
Returns
Type Description
Vehicle.LoadLimit.Builder

setEndLoadInterval(Vehicle.LoadLimit.Interval.Builder builderForValue)

public Vehicle.LoadLimit.Builder setEndLoadInterval(Vehicle.LoadLimit.Interval.Builder builderForValue)

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Parameter
Name Description
builderForValue Vehicle.LoadLimit.Interval.Builder
Returns
Type Description
Vehicle.LoadLimit.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Vehicle.LoadLimit.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

setMaxLoad(long value)

public Vehicle.LoadLimit.Builder setMaxLoad(long value)

The maximum acceptable amount of load.

optional int64 max_load = 1;

Parameter
Name Description
value long

The maxLoad to set.

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Vehicle.LoadLimit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides

setSoftMaxLoad(long value)

public Vehicle.LoadLimit.Builder setSoftMaxLoad(long value)

A soft limit of the load. See cost_per_unit_above_soft_max.

int64 soft_max_load = 2;

Parameter
Name Description
value long

The softMaxLoad to set.

Returns
Type Description
Vehicle.LoadLimit.Builder

This builder for chaining.

setStartLoadInterval(Vehicle.LoadLimit.Interval value)

public Vehicle.LoadLimit.Builder setStartLoadInterval(Vehicle.LoadLimit.Interval value)

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Parameter
Name Description
value Vehicle.LoadLimit.Interval
Returns
Type Description
Vehicle.LoadLimit.Builder

setStartLoadInterval(Vehicle.LoadLimit.Interval.Builder builderForValue)

public Vehicle.LoadLimit.Builder setStartLoadInterval(Vehicle.LoadLimit.Interval.Builder builderForValue)

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Parameter
Name Description
builderForValue Vehicle.LoadLimit.Interval.Builder
Returns
Type Description
Vehicle.LoadLimit.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Vehicle.LoadLimit.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Vehicle.LoadLimit.Builder
Overrides