Package com.google.cloud.optimization.v1

Class DistanceLimit

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.optimization.v1.DistanceLimit
All Implemented Interfaces:
DistanceLimitOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DistanceLimit extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    DistanceLimit.Builder
    A limit defining a maximum distance which can be traveled.

    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_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER
     
    static final int
    COST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER
     
    static final int
    MAX_METERS_FIELD_NUMBER
     
    static final int
    SOFT_MAX_METERS_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
    getCostPerKilometerAboveSoftMax()
    Cost per kilometer incurred if distance is above `soft_max_meters` limit.
    double
    getCostPerKilometerBelowSoftMax()
    Cost per kilometer incurred, increasing up to `soft_max_meters`, with formula: ``` min(distance_meters, soft_max_meters) / 1000.0 * cost_per_kilometer_below_soft_max. ``` This cost is not supported in `route_distance_limit`.
    static DistanceLimit
    getDefaultInstance()
     
    DistanceLimit
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getMaxMeters()
    A hard limit constraining the distance to be at most max_meters.
    com.google.protobuf.Parser<DistanceLimit>
    getParserForType()
     
    int
    getSerializedSize()
     
    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.
    boolean
    hasCostPerKilometerAboveSoftMax()
    Cost per kilometer incurred if distance is above `soft_max_meters` limit.
    boolean
    hasCostPerKilometerBelowSoftMax()
    Cost per kilometer incurred, increasing up to `soft_max_meters`, with formula: ``` min(distance_meters, soft_max_meters) / 1000.0 * cost_per_kilometer_below_soft_max. ``` This cost is not supported in `route_distance_limit`.
    int
    hashCode()
     
    boolean
    hasMaxMeters()
    A hard limit constraining the distance to be at most max_meters.
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static DistanceLimit.Builder
    newBuilder()
     
    static DistanceLimit.Builder
    newBuilder(DistanceLimit prototype)
     
    DistanceLimit.Builder
    newBuilderForType()
     
    protected DistanceLimit.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static DistanceLimit
    parseDelimitedFrom(InputStream input)
     
    static DistanceLimit
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DistanceLimit
    parseFrom(byte[] data)
     
    static DistanceLimit
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DistanceLimit
    parseFrom(com.google.protobuf.ByteString data)
     
    static DistanceLimit
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DistanceLimit
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static DistanceLimit
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DistanceLimit
    parseFrom(InputStream input)
     
    static DistanceLimit
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static DistanceLimit
    parseFrom(ByteBuffer data)
     
    static DistanceLimit
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<DistanceLimit>
    parser()
     
    DistanceLimit.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_METERS_FIELD_NUMBER

      public static final int MAX_METERS_FIELD_NUMBER
      See Also:

    • SOFT_MAX_METERS_FIELD_NUMBER

      public static final int SOFT_MAX_METERS_FIELD_NUMBER
      See Also:

    • COST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER

      public static final int COST_PER_KILOMETER_BELOW_SOFT_MAX_FIELD_NUMBER
      See Also:

    • COST_PER_KILOMETER_ABOVE_SOFT_MAX_FIELD_NUMBER

      public static final int COST_PER_KILOMETER_ABOVE_SOFT_MAX_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

    • 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;
      Specified by:
      hasMaxMeters in interface DistanceLimitOrBuilder
      Returns:
      Whether the maxMeters field is set.

    • 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;
      Specified by:
      getMaxMeters in interface DistanceLimitOrBuilder
      Returns:
      The maxMeters.

    • 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;
      Specified by:
      hasSoftMaxMeters in interface DistanceLimitOrBuilder
      Returns:
      Whether the softMaxMeters field is set.

    • 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;
      Specified by:
      getSoftMaxMeters in interface DistanceLimitOrBuilder
      Returns:
      The softMaxMeters.

    • hasCostPerKilometerBelowSoftMax

      public boolean hasCostPerKilometerBelowSoftMax()
       Cost per kilometer incurred, increasing up to `soft_max_meters`, with
 formula:
 ```
 min(distance_meters, soft_max_meters) / 1000.0 *
 cost_per_kilometer_below_soft_max.
 ```
 This cost is not supported in `route_distance_limit`.
      optional double cost_per_kilometer_below_soft_max = 4;
      Specified by:
      hasCostPerKilometerBelowSoftMax in interface DistanceLimitOrBuilder
      Returns:
      Whether the costPerKilometerBelowSoftMax field is set.

    • getCostPerKilometerBelowSoftMax

      public double getCostPerKilometerBelowSoftMax()
       Cost per kilometer incurred, increasing up to `soft_max_meters`, with
 formula:
 ```
 min(distance_meters, soft_max_meters) / 1000.0 *
 cost_per_kilometer_below_soft_max.
 ```
 This cost is not supported in `route_distance_limit`.
      optional double cost_per_kilometer_below_soft_max = 4;
      Specified by:
      getCostPerKilometerBelowSoftMax in interface DistanceLimitOrBuilder
      Returns:
      The costPerKilometerBelowSoftMax.

    • 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:
 ```
 (distance_meters - soft_max_meters) / 1000.0 *
 cost_per_kilometer_above_soft_max.
 ```
 The cost must be nonnegative.
      optional double cost_per_kilometer_above_soft_max = 3;
      Specified by:
      hasCostPerKilometerAboveSoftMax in interface DistanceLimitOrBuilder
      Returns:
      Whether the costPerKilometerAboveSoftMax field is set.

    • 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:
 ```
 (distance_meters - soft_max_meters) / 1000.0 *
 cost_per_kilometer_above_soft_max.
 ```
 The cost must be nonnegative.
      optional double cost_per_kilometer_above_soft_max = 3;
      Specified by:
      getCostPerKilometerAboveSoftMax in interface DistanceLimitOrBuilder
      Returns:
      The costPerKilometerAboveSoftMax.

    • 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 DistanceLimit parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DistanceLimit parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static DistanceLimit parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DistanceLimit.Builder newBuilder()

    • newBuilder

      public static DistanceLimit.Builder newBuilder(DistanceLimit prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DistanceLimit getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<DistanceLimit> 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 DistanceLimit getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder