Class DistanceLimit (1.41.0)

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
Type Description
int

COST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER

public static final int COST_PER_KILOMETER_BELOW_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()
Returns
Type Description
DistanceLimit

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DistanceLimit.Builder newBuilder()
Returns
Type Description
DistanceLimit.Builder

newBuilder(DistanceLimit prototype)

public static DistanceLimit.Builder newBuilder(DistanceLimit prototype)
Parameter
Name Description
prototype DistanceLimit
Returns
Type Description
DistanceLimit.Builder

parseDelimitedFrom(InputStream input)

public static DistanceLimit parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DistanceLimit parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DistanceLimit parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DistanceLimit parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DistanceLimit parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DistanceLimit parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DistanceLimit
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DistanceLimit> parser()
Returns
Type Description
Parser<DistanceLimit>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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.

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

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()
Returns
Type Description
Parser<DistanceLimit>
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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DistanceLimit.Builder newBuilderForType()
Returns
Type Description
DistanceLimit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DistanceLimit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DistanceLimit.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DistanceLimit.Builder toBuilder()
Returns
Type Description
DistanceLimit.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException