Class DistanceLimit (1.20.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
TypeDescription
int

MAX_METERS_FIELD_NUMBER

public static final int MAX_METERS_FIELD_NUMBER
Field Value
TypeDescription
int

SOFT_MAX_METERS_FIELD_NUMBER

public static final int SOFT_MAX_METERS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DistanceLimit getDefaultInstance()
Returns
TypeDescription
DistanceLimit

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DistanceLimit.Builder newBuilder()
Returns
TypeDescription
DistanceLimit.Builder

newBuilder(DistanceLimit prototype)

public static DistanceLimit.Builder newBuilder(DistanceLimit prototype)
Parameter
NameDescription
prototypeDistanceLimit
Returns
TypeDescription
DistanceLimit.Builder

parseDelimitedFrom(InputStream input)

public static DistanceLimit parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DistanceLimit parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DistanceLimit parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DistanceLimit parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DistanceLimit parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DistanceLimit parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DistanceLimit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DistanceLimit> parser()
Returns
TypeDescription
Parser<DistanceLimit>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
double

The costPerKilometerAboveSoftMax.

getDefaultInstanceForType()

public DistanceLimit getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
long

The maxMeters.

getParserForType()

public Parser<DistanceLimit> getParserForType()
Returns
TypeDescription
Parser<DistanceLimit>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the softMaxMeters field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DistanceLimit.Builder newBuilderForType()
Returns
TypeDescription
DistanceLimit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DistanceLimit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DistanceLimit.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DistanceLimit.Builder toBuilder()
Returns
TypeDescription
DistanceLimit.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException