publicfinalclass DistanceLimitextendsGeneratedMessageV3implementsDistanceLimitOrBuilder
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)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
publicstaticfinalintCOST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
COST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER
publicstaticfinalintCOST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
MAX_METERS_FIELD_NUMBER
publicstaticfinalintMAX_METERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SOFT_MAX_METERS_FIELD_NUMBER
publicstaticfinalintSOFT_MAX_METERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticDistanceLimitgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticDistanceLimit.BuildernewBuilder()
newBuilder(DistanceLimit prototype)
publicstaticDistanceLimit.BuildernewBuilder(DistanceLimitprototype)
publicstaticDistanceLimitparseDelimitedFrom(InputStreaminput)
publicstaticDistanceLimitparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticDistanceLimitparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticDistanceLimitparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticDistanceLimitparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticDistanceLimitparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticDistanceLimitparseFrom(CodedInputStreaminput)
publicstaticDistanceLimitparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticDistanceLimitparseFrom(InputStreaminput)
publicstaticDistanceLimitparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticDistanceLimitparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticDistanceLimitparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<DistanceLimit>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCostPerKilometerAboveSoftMax()
publicdoublegetCostPerKilometerAboveSoftMax()
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()
publicdoublegetCostPerKilometerBelowSoftMax()
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()
publicDistanceLimitgetDefaultInstanceForType()
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()
publicParser<DistanceLimit>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getSoftMaxMeters()
publiclonggetSoftMaxMeters()
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()
publicbooleanhasCostPerKilometerAboveSoftMax()
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()
publicbooleanhasCostPerKilometerBelowSoftMax()
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()
publicbooleanhasMaxMeters()
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()
publicbooleanhasSoftMaxMeters()
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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicDistanceLimit.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedDistanceLimit.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicDistanceLimit.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides