public final class DistanceLimit extends GeneratedMessageV3 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 Fields
COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
public static final int COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
Field Value
MAX_METERS_FIELD_NUMBER
public static final int MAX_METERS_FIELD_NUMBER
Field Value
SOFT_MAX_METERS_FIELD_NUMBER
public static final int SOFT_MAX_METERS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DistanceLimit getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DistanceLimit.Builder newBuilder()
Returns
newBuilder(DistanceLimit prototype)
public static DistanceLimit.Builder newBuilder(DistanceLimit prototype)
Parameter
Returns
public static DistanceLimit parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DistanceLimit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DistanceLimit parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DistanceLimit parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DistanceLimit parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DistanceLimit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DistanceLimit parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DistanceLimit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DistanceLimit parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DistanceLimit> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
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
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.
|
getParserForType()
public Parser<DistanceLimit> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DistanceLimit.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DistanceLimit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DistanceLimit.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
