Class DistanceLimit.Builder (1.19.0)

public static final class DistanceLimit.Builder extends GeneratedMessageV3.Builder<DistanceLimit.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DistanceLimit.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DistanceLimit.Builder
Overrides

build()

public DistanceLimit build()
Returns
TypeDescription
DistanceLimit

buildPartial()

public DistanceLimit buildPartial()
Returns
TypeDescription
DistanceLimit

clear()

public DistanceLimit.Builder clear()
Returns
TypeDescription
DistanceLimit.Builder
Overrides

clearCostPerKilometerAboveSoftMax()

public DistanceLimit.Builder clearCostPerKilometerAboveSoftMax()

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
DistanceLimit.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DistanceLimit.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DistanceLimit.Builder
Overrides

clearMaxMeters()

public DistanceLimit.Builder clearMaxMeters()

A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.

optional int64 max_meters = 1;

Returns
TypeDescription
DistanceLimit.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DistanceLimit.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DistanceLimit.Builder
Overrides

clearSoftMaxMeters()

public DistanceLimit.Builder clearSoftMaxMeters()

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
DistanceLimit.Builder

This builder for chaining.

clone()

public DistanceLimit.Builder clone()
Returns
TypeDescription
DistanceLimit.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(DistanceLimit other)

public DistanceLimit.Builder mergeFrom(DistanceLimit other)
Parameter
NameDescription
otherDistanceLimit
Returns
TypeDescription
DistanceLimit.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DistanceLimit.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DistanceLimit.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public DistanceLimit.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
DistanceLimit.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DistanceLimit.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DistanceLimit.Builder
Overrides

setCostPerKilometerAboveSoftMax(double value)

public DistanceLimit.Builder setCostPerKilometerAboveSoftMax(double value)

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;

Parameter
NameDescription
valuedouble

The costPerKilometerAboveSoftMax to set.

Returns
TypeDescription
DistanceLimit.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DistanceLimit.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DistanceLimit.Builder
Overrides

setMaxMeters(long value)

public DistanceLimit.Builder setMaxMeters(long value)

A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.

optional int64 max_meters = 1;

Parameter
NameDescription
valuelong

The maxMeters to set.

Returns
TypeDescription
DistanceLimit.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DistanceLimit.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
DistanceLimit.Builder
Overrides

setSoftMaxMeters(long value)

public DistanceLimit.Builder setSoftMaxMeters(long value)

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;

Parameter
NameDescription
valuelong

The softMaxMeters to set.

Returns
TypeDescription
DistanceLimit.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DistanceLimit.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
DistanceLimit.Builder
Overrides