Package com.google.cloud.optimization.v1

Class Vehicle.LoadLimit

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.optimization.v1.Vehicle.LoadLimit
All Implemented Interfaces:
Vehicle.LoadLimitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Vehicle
public static final class Vehicle.LoadLimit extends com.google.protobuf.GeneratedMessage 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][google.cloud.optimization.v1.Vehicle.load_limits].
Protobuf type google.cloud.optimization.v1.Vehicle.LoadLimit
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Vehicle.LoadLimit.Builder
    Defines a load limit applying to a vehicle, e.g.
    static final class 
    Vehicle.LoadLimit.Interval
    Interval of acceptable load amounts.
    static interface 
    Vehicle.LoadLimit.IntervalOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COST_PER_UNIT_ABOVE_SOFT_MAX_FIELD_NUMBER
     
    static final int
    END_LOAD_INTERVAL_FIELD_NUMBER
     
    static final int
    MAX_LOAD_FIELD_NUMBER
     
    static final int
    SOFT_MAX_LOAD_FIELD_NUMBER
     
    static final int
    START_LOAD_INTERVAL_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    double
    getCostPerUnitAboveSoftMax()
    If the load ever exceeds [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load] along this vehicle's route, the following cost penalty applies (only once per vehicle): (load - [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load]) * [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max].
    static Vehicle.LoadLimit
    getDefaultInstance()
     
    Vehicle.LoadLimit
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Vehicle.LoadLimit.Interval
    getEndLoadInterval()
    The acceptable load interval of the vehicle at the end of the route.
    Vehicle.LoadLimit.IntervalOrBuilder
    getEndLoadIntervalOrBuilder()
    The acceptable load interval of the vehicle at the end of the route.
    long
    getMaxLoad()
    The maximum acceptable amount of load.
    com.google.protobuf.Parser<Vehicle.LoadLimit>
    getParserForType()
     
    int
    getSerializedSize()
     
    long
    getSoftMaxLoad()
    A soft limit of the load.
    Vehicle.LoadLimit.Interval
    getStartLoadInterval()
    The acceptable load interval of the vehicle at the start of the route.
    Vehicle.LoadLimit.IntervalOrBuilder
    getStartLoadIntervalOrBuilder()
    The acceptable load interval of the vehicle at the start of the route.
    boolean
    hasEndLoadInterval()
    The acceptable load interval of the vehicle at the end of the route.
    int
    hashCode()
     
    boolean
    hasMaxLoad()
    The maximum acceptable amount of load.
    boolean
    hasStartLoadInterval()
    The acceptable load interval of the vehicle at the start of the route.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Vehicle.LoadLimit.Builder
    newBuilder()
     
    static Vehicle.LoadLimit.Builder
    newBuilder(Vehicle.LoadLimit prototype)
     
    Vehicle.LoadLimit.Builder
    newBuilderForType()
     
    protected Vehicle.LoadLimit.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Vehicle.LoadLimit
    parseDelimitedFrom(InputStream input)
     
    static Vehicle.LoadLimit
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Vehicle.LoadLimit
    parseFrom(byte[] data)
     
    static Vehicle.LoadLimit
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Vehicle.LoadLimit
    parseFrom(com.google.protobuf.ByteString data)
     
    static Vehicle.LoadLimit
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Vehicle.LoadLimit
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Vehicle.LoadLimit
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Vehicle.LoadLimit
    parseFrom(InputStream input)
     
    static Vehicle.LoadLimit
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Vehicle.LoadLimit
    parseFrom(ByteBuffer data)
     
    static Vehicle.LoadLimit
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Vehicle.LoadLimit>
    parser()
     
    Vehicle.LoadLimit.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • MAX_LOAD_FIELD_NUMBER

      public static final int MAX_LOAD_FIELD_NUMBER
      See Also:

    • SOFT_MAX_LOAD_FIELD_NUMBER

      public static final int SOFT_MAX_LOAD_FIELD_NUMBER
      See Also:

    • COST_PER_UNIT_ABOVE_SOFT_MAX_FIELD_NUMBER

      public static final int COST_PER_UNIT_ABOVE_SOFT_MAX_FIELD_NUMBER
      See Also:

    • START_LOAD_INTERVAL_FIELD_NUMBER

      public static final int START_LOAD_INTERVAL_FIELD_NUMBER
      See Also:

    • END_LOAD_INTERVAL_FIELD_NUMBER

      public static final int END_LOAD_INTERVAL_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasMaxLoad

      public boolean hasMaxLoad()
       The maximum acceptable amount of load.
      optional int64 max_load = 1;
      Specified by:
      hasMaxLoad in interface Vehicle.LoadLimitOrBuilder
      Returns:
      Whether the maxLoad field is set.

    • getMaxLoad

      public long getMaxLoad()
       The maximum acceptable amount of load.
      optional int64 max_load = 1;
      Specified by:
      getMaxLoad in interface Vehicle.LoadLimitOrBuilder
      Returns:
      The maxLoad.

    • getSoftMaxLoad

      public long getSoftMaxLoad()
       A soft limit of the load. See
 [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max].
      int64 soft_max_load = 2;
      Specified by:
      getSoftMaxLoad in interface Vehicle.LoadLimitOrBuilder
      Returns:
      The softMaxLoad.

    • getCostPerUnitAboveSoftMax

      public double getCostPerUnitAboveSoftMax()
       If the load ever exceeds
 [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load]
 along this vehicle's route, the following cost penalty applies (only once
 per vehicle): (load -
 [soft_max_load][google.cloud.optimization.v1.Vehicle.LoadLimit.soft_max_load])
 * [cost_per_unit_above_soft_max][google.cloud.optimization.v1.Vehicle.LoadLimit.cost_per_unit_above_soft_max]. All costs
 add up and must be in the same unit as
 [Shipment.penalty_cost][google.cloud.optimization.v1.Shipment.penalty_cost].
      double cost_per_unit_above_soft_max = 3;
      Specified by:
      getCostPerUnitAboveSoftMax in interface Vehicle.LoadLimitOrBuilder
      Returns:
      The costPerUnitAboveSoftMax.

    • 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;
      Specified by:
      hasStartLoadInterval in interface Vehicle.LoadLimitOrBuilder
      Returns:
      Whether the startLoadInterval field is set.

    • 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;
      Specified by:
      getStartLoadInterval in interface Vehicle.LoadLimitOrBuilder
      Returns:
      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;
      Specified by:
      getStartLoadIntervalOrBuilder in interface Vehicle.LoadLimitOrBuilder

    • 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;
      Specified by:
      hasEndLoadInterval in interface Vehicle.LoadLimitOrBuilder
      Returns:
      Whether the endLoadInterval field is set.

    • 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;
      Specified by:
      getEndLoadInterval in interface Vehicle.LoadLimitOrBuilder
      Returns:
      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;
      Specified by:
      getEndLoadIntervalOrBuilder in interface Vehicle.LoadLimitOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Vehicle.LoadLimit parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Vehicle.LoadLimit parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Vehicle.LoadLimit parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Vehicle.LoadLimit.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Vehicle.LoadLimit.Builder newBuilder()

    • newBuilder

      public static Vehicle.LoadLimit.Builder newBuilder(Vehicle.LoadLimit prototype)

    • toBuilder

      public Vehicle.LoadLimit.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Vehicle.LoadLimit.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Vehicle.LoadLimit getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Vehicle.LoadLimit> parser()

    • getParserForType

      public com.google.protobuf.Parser<Vehicle.LoadLimit> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Vehicle.LoadLimit getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder