Send feedback
Class DistanceLimit (1.17.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.17.0 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
public static final int COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
Field Value Type Description int
MAX_METERS_FIELD_NUMBER
public static final int MAX_METERS_FIELD_NUMBER
Field Value Type Description int
SOFT_MAX_METERS_FIELD_NUMBER
public static final int SOFT_MAX_METERS_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static DistanceLimit getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DistanceLimit . Builder newBuilder ()
newBuilder(DistanceLimit prototype)
public static DistanceLimit . Builder newBuilder ( DistanceLimit prototype )
public static DistanceLimit parseDelimitedFrom ( InputStream input )
public static DistanceLimit parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DistanceLimit parseFrom ( byte [] data )
Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DistanceLimit parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DistanceLimit parseFrom ( CodedInputStream input )
public static DistanceLimit parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DistanceLimit parseFrom ( InputStream input )
public static DistanceLimit parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DistanceLimit parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DistanceLimit parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DistanceLimit> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description objObject
Overrides
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.
getDefaultInstanceForType()
public DistanceLimit getDefaultInstanceForType ()
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.
getParserForType()
public Parser<DistanceLimit> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
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;
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.
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.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DistanceLimit . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DistanceLimit . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public DistanceLimit . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
