Class Vehicle.DurationLimit.Builder (1.40.0)

public static final class Vehicle.DurationLimit.Builder extends GeneratedMessageV3.Builder<Vehicle.DurationLimit.Builder> implements Vehicle.DurationLimitOrBuilder

A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft.

When a soft limit field is defined, both the soft max threshold and its associated cost must be defined together.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearCostPerHourAfterSoftMax()

public Vehicle.DurationLimit.Builder clearCostPerHourAfterSoftMax()

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: <code><code> cost_per_hour_after_soft_max * (duration - soft_max_duration) </code></code> The cost must be nonnegative.

optional double cost_per_hour_after_soft_max = 3;

Returns
Type Description
Vehicle.DurationLimit.Builder

This builder for chaining.

clearCostPerSquareHourAfterQuadraticSoftMax()

public Vehicle.DurationLimit.Builder clearCostPerSquareHourAfterQuadraticSoftMax()

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

<code><code> cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 </code></code>

The cost must be nonnegative.

optional double cost_per_square_hour_after_quadratic_soft_max = 5;

Returns
Type Description
Vehicle.DurationLimit.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearMaxDuration()

public Vehicle.DurationLimit.Builder clearMaxDuration()

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Returns
Type Description
Vehicle.DurationLimit.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQuadraticSoftMaxDuration()

public Vehicle.DurationLimit.Builder clearQuadraticSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Returns
Type Description
Vehicle.DurationLimit.Builder

clearSoftMaxDuration()

public Vehicle.DurationLimit.Builder clearSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Returns
Type Description
Vehicle.DurationLimit.Builder

clone()

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

getCostPerHourAfterSoftMax()

public double getCostPerHourAfterSoftMax()

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: <code><code> cost_per_hour_after_soft_max * (duration - soft_max_duration) </code></code> The cost must be nonnegative.

optional double cost_per_hour_after_soft_max = 3;

Returns
Type Description
double

The costPerHourAfterSoftMax.

getCostPerSquareHourAfterQuadraticSoftMax()

public double getCostPerSquareHourAfterQuadraticSoftMax()

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

<code><code> cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 </code></code>

The cost must be nonnegative.

optional double cost_per_square_hour_after_quadratic_soft_max = 5;

Returns
Type Description
double

The costPerSquareHourAfterQuadraticSoftMax.

getDefaultInstanceForType()

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

getDescriptorForType()

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

getMaxDuration()

public Duration getMaxDuration()

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Returns
Type Description
Duration

The maxDuration.

getMaxDurationBuilder()

public Duration.Builder getMaxDurationBuilder()

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Returns
Type Description
Builder

getMaxDurationOrBuilder()

public DurationOrBuilder getMaxDurationOrBuilder()

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Returns
Type Description
DurationOrBuilder

getQuadraticSoftMaxDuration()

public Duration getQuadraticSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Returns
Type Description
Duration

The quadraticSoftMaxDuration.

getQuadraticSoftMaxDurationBuilder()

public Duration.Builder getQuadraticSoftMaxDurationBuilder()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Returns
Type Description
Builder

getQuadraticSoftMaxDurationOrBuilder()

public DurationOrBuilder getQuadraticSoftMaxDurationOrBuilder()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Returns
Type Description
DurationOrBuilder

getSoftMaxDuration()

public Duration getSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Returns
Type Description
Duration

The softMaxDuration.

getSoftMaxDurationBuilder()

public Duration.Builder getSoftMaxDurationBuilder()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Returns
Type Description
Builder

getSoftMaxDurationOrBuilder()

public DurationOrBuilder getSoftMaxDurationOrBuilder()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Returns
Type Description
DurationOrBuilder

hasCostPerHourAfterSoftMax()

public boolean hasCostPerHourAfterSoftMax()

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: <code><code> cost_per_hour_after_soft_max * (duration - soft_max_duration) </code></code> The cost must be nonnegative.

optional double cost_per_hour_after_soft_max = 3;

Returns
Type Description
boolean

Whether the costPerHourAfterSoftMax field is set.

hasCostPerSquareHourAfterQuadraticSoftMax()

public boolean hasCostPerSquareHourAfterQuadraticSoftMax()

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

<code><code> cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 </code></code>

The cost must be nonnegative.

optional double cost_per_square_hour_after_quadratic_soft_max = 5;

Returns
Type Description
boolean

Whether the costPerSquareHourAfterQuadraticSoftMax field is set.

hasMaxDuration()

public boolean hasMaxDuration()

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Returns
Type Description
boolean

Whether the maxDuration field is set.

hasQuadraticSoftMaxDuration()

public boolean hasQuadraticSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Returns
Type Description
boolean

Whether the quadraticSoftMaxDuration field is set.

hasSoftMaxDuration()

public boolean hasSoftMaxDuration()

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Returns
Type Description
boolean

Whether the softMaxDuration field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Vehicle.DurationLimit other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder mergeMaxDuration(Duration value)

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

mergeQuadraticSoftMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder mergeQuadraticSoftMaxDuration(Duration value)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

mergeSoftMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder mergeSoftMaxDuration(Duration value)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCostPerHourAfterSoftMax(double value)

public Vehicle.DurationLimit.Builder setCostPerHourAfterSoftMax(double value)

Cost per hour incurred if the soft_max_duration threshold is violated. The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows: <code><code> cost_per_hour_after_soft_max * (duration - soft_max_duration) </code></code> The cost must be nonnegative.

optional double cost_per_hour_after_soft_max = 3;

Parameter
Name Description
value double

The costPerHourAfterSoftMax to set.

Returns
Type Description
Vehicle.DurationLimit.Builder

This builder for chaining.

setCostPerSquareHourAfterQuadraticSoftMax(double value)

public Vehicle.DurationLimit.Builder setCostPerSquareHourAfterQuadraticSoftMax(double value)

Cost per square hour incurred if the quadratic_soft_max_duration threshold is violated.

The additional cost is 0 if the duration is under the threshold, otherwise the cost depends on the duration as follows:

<code><code> cost_per_square_hour_after_quadratic_soft_max * (duration - quadratic_soft_max_duration)^2 </code></code>

The cost must be nonnegative.

optional double cost_per_square_hour_after_quadratic_soft_max = 5;

Parameter
Name Description
value double

The costPerSquareHourAfterQuadraticSoftMax to set.

Returns
Type Description
Vehicle.DurationLimit.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder setMaxDuration(Duration value)

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

setMaxDuration(Duration.Builder builderForValue)

public Vehicle.DurationLimit.Builder setMaxDuration(Duration.Builder builderForValue)

A hard limit constraining the duration to be at most max_duration.

.google.protobuf.Duration max_duration = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Vehicle.DurationLimit.Builder

setQuadraticSoftMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder setQuadraticSoftMaxDuration(Duration value)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

setQuadraticSoftMaxDuration(Duration.Builder builderForValue)

public Vehicle.DurationLimit.Builder setQuadraticSoftMaxDuration(Duration.Builder builderForValue)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost, quadratic in the duration. This cost adds up to other costs defined in the model, with the same unit.

If defined, quadratic_soft_max_duration must be nonnegative. If max_duration is also defined, quadratic_soft_max_duration must be less than max_duration, and the difference must be no larger than one day:

<code>max_duration - quadratic_soft_max_duration &lt;= 86400 seconds</code>

.google.protobuf.Duration quadratic_soft_max_duration = 4;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Vehicle.DurationLimit.Builder

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

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

setSoftMaxDuration(Duration value)

public Vehicle.DurationLimit.Builder setSoftMaxDuration(Duration value)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Parameter
Name Description
value Duration
Returns
Type Description
Vehicle.DurationLimit.Builder

setSoftMaxDuration(Duration.Builder builderForValue)

public Vehicle.DurationLimit.Builder setSoftMaxDuration(Duration.Builder builderForValue)

A soft limit not enforcing a maximum duration limit, but when violated makes the route incur a cost. This cost adds up to other costs defined in the model, with the same unit.

If defined, soft_max_duration must be nonnegative. If max_duration is also defined, soft_max_duration must be less than max_duration.

.google.protobuf.Duration soft_max_duration = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Vehicle.DurationLimit.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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