Class Vehicle.LoadLimit (1.38.0)

public static final class Vehicle.LoadLimit extends GeneratedMessageV3 implements Vehicle.LoadLimitOrBuilder

Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See load_limits.

Protobuf type google.cloud.optimization.v1.Vehicle.LoadLimit

Static Fields

COST_PER_UNIT_ABOVE_SOFT_MAX_FIELD_NUMBER

public static final int COST_PER_UNIT_ABOVE_SOFT_MAX_FIELD_NUMBER
Field Value
TypeDescription
int

END_LOAD_INTERVAL_FIELD_NUMBER

public static final int END_LOAD_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_LOAD_FIELD_NUMBER

public static final int MAX_LOAD_FIELD_NUMBER
Field Value
TypeDescription
int

SOFT_MAX_LOAD_FIELD_NUMBER

public static final int SOFT_MAX_LOAD_FIELD_NUMBER
Field Value
TypeDescription
int

START_LOAD_INTERVAL_FIELD_NUMBER

public static final int START_LOAD_INTERVAL_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Vehicle.LoadLimit getDefaultInstance()
Returns
TypeDescription
Vehicle.LoadLimit

getDescriptor()

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

newBuilder()

public static Vehicle.LoadLimit.Builder newBuilder()
Returns
TypeDescription
Vehicle.LoadLimit.Builder

newBuilder(Vehicle.LoadLimit prototype)

public static Vehicle.LoadLimit.Builder newBuilder(Vehicle.LoadLimit prototype)
Parameter
NameDescription
prototypeVehicle.LoadLimit
Returns
TypeDescription
Vehicle.LoadLimit.Builder

parseDelimitedFrom(InputStream input)

public static Vehicle.LoadLimit parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Vehicle.LoadLimit
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Vehicle.LoadLimit parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Vehicle.LoadLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Vehicle.LoadLimit parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Vehicle.LoadLimit
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Vehicle.LoadLimit parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Vehicle.LoadLimit
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Vehicle.LoadLimit parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Vehicle.LoadLimit
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Vehicle.LoadLimit> parser()
Returns
TypeDescription
Parser<LoadLimit>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCostPerUnitAboveSoftMax()

public double getCostPerUnitAboveSoftMax()

If the load ever exceeds soft_max_load along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - soft_max_load)

  • cost_per_unit_above_soft_max. All costs add up and must be in the same unit as Shipment.penalty_cost.

double cost_per_unit_above_soft_max = 3;

Returns
TypeDescription
double

The costPerUnitAboveSoftMax.

getDefaultInstanceForType()

public Vehicle.LoadLimit getDefaultInstanceForType()
Returns
TypeDescription
Vehicle.LoadLimit

getEndLoadInterval()

public Vehicle.LoadLimit.Interval getEndLoadInterval()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
TypeDescription
Vehicle.LoadLimit.Interval

The endLoadInterval.

getEndLoadIntervalOrBuilder()

public Vehicle.LoadLimit.IntervalOrBuilder getEndLoadIntervalOrBuilder()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
TypeDescription
Vehicle.LoadLimit.IntervalOrBuilder

getMaxLoad()

public long getMaxLoad()

The maximum acceptable amount of load.

optional int64 max_load = 1;

Returns
TypeDescription
long

The maxLoad.

getParserForType()

public Parser<Vehicle.LoadLimit> getParserForType()
Returns
TypeDescription
Parser<LoadLimit>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSoftMaxLoad()

public long getSoftMaxLoad()

A soft limit of the load. See cost_per_unit_above_soft_max.

int64 soft_max_load = 2;

Returns
TypeDescription
long

The softMaxLoad.

getStartLoadInterval()

public Vehicle.LoadLimit.Interval getStartLoadInterval()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
TypeDescription
Vehicle.LoadLimit.Interval

The startLoadInterval.

getStartLoadIntervalOrBuilder()

public Vehicle.LoadLimit.IntervalOrBuilder getStartLoadIntervalOrBuilder()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
TypeDescription
Vehicle.LoadLimit.IntervalOrBuilder

hasEndLoadInterval()

public boolean hasEndLoadInterval()

The acceptable load interval of the vehicle at the end of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval end_load_interval = 5;

Returns
TypeDescription
boolean

Whether the endLoadInterval field is set.

hasMaxLoad()

public boolean hasMaxLoad()

The maximum acceptable amount of load.

optional int64 max_load = 1;

Returns
TypeDescription
boolean

Whether the maxLoad field is set.

hasStartLoadInterval()

public boolean hasStartLoadInterval()

The acceptable load interval of the vehicle at the start of the route.

.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval start_load_interval = 4;

Returns
TypeDescription
boolean

Whether the startLoadInterval 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 Vehicle.LoadLimit.Builder newBuilderForType()
Returns
TypeDescription
Vehicle.LoadLimit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Vehicle.LoadLimit.Builder toBuilder()
Returns
TypeDescription
Vehicle.LoadLimit.Builder

writeTo(CodedOutputStream output)

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