public static final class DistanceLimit.Builder extends GeneratedMessageV3.Builder<DistanceLimit.Builder> implements DistanceLimitOrBuilder
A limit defining a maximum distance which can be traveled. It can be either
hard or soft.
If a soft limit is defined, both soft_max_meters and
cost_per_kilometer_above_soft_max must be defined and be nonnegative.
Protobuf type google.cloud.optimization.v1.DistanceLimit
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DistanceLimit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public DistanceLimit build()
Returns
buildPartial()
public DistanceLimit buildPartial()
Returns
clear()
public DistanceLimit.Builder clear()
Returns
Overrides
clearCostPerKilometerAboveSoftMax()
public DistanceLimit.Builder clearCostPerKilometerAboveSoftMax()
Cost per kilometer incurred if soft_max_meters limit is violated. The
additional cost is 0 if the distance is under the limit, otherwise the
formula used to compute the cost is the following:
<code><code>
(distance_meters - soft_max_meters) / 1000.0 *
cost_per_kilometer_above_soft_max.
</code></code>
The cost must be nonnegative.
optional double cost_per_kilometer_above_soft_max = 3;
clearField(Descriptors.FieldDescriptor field)
public DistanceLimit.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearMaxMeters()
public DistanceLimit.Builder clearMaxMeters()
A hard limit constraining the distance to be at most max_meters. The limit
must be nonnegative.
optional int64 max_meters = 1;
clearOneof(Descriptors.OneofDescriptor oneof)
public DistanceLimit.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearSoftMaxMeters()
public DistanceLimit.Builder clearSoftMaxMeters()
A soft limit not enforcing a maximum distance limit, but when violated
results in a cost which adds up to other costs defined in the model,
with the same unit.
If defined soft_max_meters must be less than max_meters and must be
nonnegative.
optional int64 soft_max_meters = 2;
clone()
public DistanceLimit.Builder clone()
Returns
Overrides
getCostPerKilometerAboveSoftMax()
public double getCostPerKilometerAboveSoftMax()
Cost per kilometer incurred if soft_max_meters limit is violated. The
additional cost is 0 if the distance is under the limit, otherwise the
formula used to compute the cost is the following:
<code><code>
(distance_meters - soft_max_meters) / 1000.0 *
cost_per_kilometer_above_soft_max.
</code></code>
The cost must be nonnegative.
optional double cost_per_kilometer_above_soft_max = 3;
| Type | Description |
| double | The costPerKilometerAboveSoftMax.
|
getDefaultInstanceForType()
public DistanceLimit getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMaxMeters()
public long getMaxMeters()
A hard limit constraining the distance to be at most max_meters. The limit
must be nonnegative.
optional int64 max_meters = 1;
| Type | Description |
| long | The maxMeters.
|
getSoftMaxMeters()
public long getSoftMaxMeters()
A soft limit not enforcing a maximum distance limit, but when violated
results in a cost which adds up to other costs defined in the model,
with the same unit.
If defined soft_max_meters must be less than max_meters and must be
nonnegative.
optional int64 soft_max_meters = 2;
| Type | Description |
| long | The softMaxMeters.
|
hasCostPerKilometerAboveSoftMax()
public boolean hasCostPerKilometerAboveSoftMax()
Cost per kilometer incurred if soft_max_meters limit is violated. The
additional cost is 0 if the distance is under the limit, otherwise the
formula used to compute the cost is the following:
<code><code>
(distance_meters - soft_max_meters) / 1000.0 *
cost_per_kilometer_above_soft_max.
</code></code>
The cost must be nonnegative.
optional double cost_per_kilometer_above_soft_max = 3;
| Type | Description |
| boolean | Whether the costPerKilometerAboveSoftMax field is set.
|
hasMaxMeters()
public boolean hasMaxMeters()
A hard limit constraining the distance to be at most max_meters. The limit
must be nonnegative.
optional int64 max_meters = 1;
| Type | Description |
| boolean | Whether the maxMeters field is set.
|
hasSoftMaxMeters()
public boolean hasSoftMaxMeters()
A soft limit not enforcing a maximum distance limit, but when violated
results in a cost which adds up to other costs defined in the model,
with the same unit.
If defined soft_max_meters must be less than max_meters and must be
nonnegative.
optional int64 soft_max_meters = 2;
| Type | Description |
| boolean | Whether the softMaxMeters field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(DistanceLimit other)
public DistanceLimit.Builder mergeFrom(DistanceLimit other)
Parameter
Returns
public DistanceLimit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public DistanceLimit.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DistanceLimit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setCostPerKilometerAboveSoftMax(double value)
public DistanceLimit.Builder setCostPerKilometerAboveSoftMax(double value)
Cost per kilometer incurred if soft_max_meters limit is violated. The
additional cost is 0 if the distance is under the limit, otherwise the
formula used to compute the cost is the following:
<code><code>
(distance_meters - soft_max_meters) / 1000.0 *
cost_per_kilometer_above_soft_max.
</code></code>
The cost must be nonnegative.
optional double cost_per_kilometer_above_soft_max = 3;
| Name | Description |
| value | double
The costPerKilometerAboveSoftMax to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public DistanceLimit.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setMaxMeters(long value)
public DistanceLimit.Builder setMaxMeters(long value)
A hard limit constraining the distance to be at most max_meters. The limit
must be nonnegative.
optional int64 max_meters = 1;
| Name | Description |
| value | long
The maxMeters to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DistanceLimit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setSoftMaxMeters(long value)
public DistanceLimit.Builder setSoftMaxMeters(long value)
A soft limit not enforcing a maximum distance limit, but when violated
results in a cost which adds up to other costs defined in the model,
with the same unit.
If defined soft_max_meters must be less than max_meters and must be
nonnegative.
optional int64 soft_max_meters = 2;
| Name | Description |
| value | long
The softMaxMeters to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final DistanceLimit.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
