public static final class DistanceLimit.Builder extends GeneratedMessageV3.Builder<DistanceLimit.Builder> implements DistanceLimitOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DistanceLimit.BuilderImplements
DistanceLimitOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DistanceLimit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
build()
public DistanceLimit build()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
buildPartial()
public DistanceLimit buildPartial()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
clear()
public DistanceLimit.Builder clear()| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
clearCostPerKilometerAboveSoftMax()
public DistanceLimit.Builder clearCostPerKilometerAboveSoftMax() Cost per kilometer incurred if distance is above soft_max_meters limit.
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;
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clearCostPerKilometerBelowSoftMax()
public DistanceLimit.Builder clearCostPerKilometerBelowSoftMax() Cost per kilometer incurred, increasing up to soft_max_meters, with
formula:
<code><code>
min(distance_meters, soft_max_meters) / 1000.0 *
cost_per_kilometer_below_soft_max.
</code></code><code>
This cost is not supported in </code>route_distance_limit.
optional double cost_per_kilometer_below_soft_max = 4;
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public DistanceLimit.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DistanceLimit.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clone()
public DistanceLimit.Builder clone()| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
getCostPerKilometerAboveSoftMax()
public double getCostPerKilometerAboveSoftMax() Cost per kilometer incurred if distance is above soft_max_meters limit.
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;
| Returns | |
|---|---|
| Type | Description |
double |
The costPerKilometerAboveSoftMax. |
getCostPerKilometerBelowSoftMax()
public double getCostPerKilometerBelowSoftMax() Cost per kilometer incurred, increasing up to soft_max_meters, with
formula:
<code><code>
min(distance_meters, soft_max_meters) / 1000.0 *
cost_per_kilometer_below_soft_max.
</code></code><code>
This cost is not supported in </code>route_distance_limit.
optional double cost_per_kilometer_below_soft_max = 4;
| Returns | |
|---|---|
| Type | Description |
double |
The costPerKilometerBelowSoftMax. |
getDefaultInstanceForType()
public DistanceLimit getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
long |
The softMaxMeters. |
hasCostPerKilometerAboveSoftMax()
public boolean hasCostPerKilometerAboveSoftMax() Cost per kilometer incurred if distance is above soft_max_meters limit.
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costPerKilometerAboveSoftMax field is set. |
hasCostPerKilometerBelowSoftMax()
public boolean hasCostPerKilometerBelowSoftMax() Cost per kilometer incurred, increasing up to soft_max_meters, with
formula:
<code><code>
min(distance_meters, soft_max_meters) / 1000.0 *
cost_per_kilometer_below_soft_max.
</code></code><code>
This cost is not supported in </code>route_distance_limit.
optional double cost_per_kilometer_below_soft_max = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costPerKilometerBelowSoftMax 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softMaxMeters field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DistanceLimit other)
public DistanceLimit.Builder mergeFrom(DistanceLimit other)| Parameter | |
|---|---|
| Name | Description |
other |
DistanceLimit |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DistanceLimit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DistanceLimit.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DistanceLimit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
setCostPerKilometerAboveSoftMax(double value)
public DistanceLimit.Builder setCostPerKilometerAboveSoftMax(double value) Cost per kilometer incurred if distance is above soft_max_meters limit.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe costPerKilometerAboveSoftMax to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setCostPerKilometerBelowSoftMax(double value)
public DistanceLimit.Builder setCostPerKilometerBelowSoftMax(double value) Cost per kilometer incurred, increasing up to soft_max_meters, with
formula:
<code><code>
min(distance_meters, soft_max_meters) / 1000.0 *
cost_per_kilometer_below_soft_max.
</code></code><code>
This cost is not supported in </code>route_distance_limit.
optional double cost_per_kilometer_below_soft_max = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe costPerKilometerBelowSoftMax to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public DistanceLimit.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxMeters to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DistanceLimit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe softMaxMeters to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DistanceLimit.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|