Class DistanceLimit.Builder (1.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 1.76.0 (latest)
- 1.74.0
- 1.73.0
- 1.72.0
- 1.71.0
- 1.70.0
- 1.68.0
- 1.66.0
- 1.65.0
- 1.62.0
- 1.61.0
- 1.60.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.14
- 0.1.2
publicstaticfinalclass DistanceLimit.BuilderextendsGeneratedMessageV3.Builder<DistanceLimit.Builder>implementsDistanceLimitOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DistanceLimit.BuilderImplements
DistanceLimitOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicDistanceLimit.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
build()
publicDistanceLimitbuild()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
buildPartial()
publicDistanceLimitbuildPartial()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
clear()
publicDistanceLimit.Builderclear()| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
clearCostPerKilometerAboveSoftMax()
publicDistanceLimit.BuilderclearCostPerKilometerAboveSoftMax() 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 | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
publicDistanceLimit.BuilderclearField(Descriptors.FieldDescriptorfield)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
clearMaxMeters()
publicDistanceLimit.BuilderclearMaxMeters()A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.
optional int64 max_meters = 1;
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
publicDistanceLimit.BuilderclearOneof(Descriptors.OneofDescriptoroneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
clearSoftMaxMeters()
publicDistanceLimit.BuilderclearSoftMaxMeters()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 | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
clone()
publicDistanceLimit.Builderclone()| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
getCostPerKilometerAboveSoftMax()
publicdoublegetCostPerKilometerAboveSoftMax() 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 | |
|---|---|
| Type | Description |
double |
The costPerKilometerAboveSoftMax. |
getDefaultInstanceForType()
publicDistanceLimitgetDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DistanceLimit |
|
getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMaxMeters()
publiclonggetMaxMeters()A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.
optional int64 max_meters = 1;
| Returns | |
|---|---|
| Type | Description |
long |
The maxMeters. |
getSoftMaxMeters()
publiclonggetSoftMaxMeters()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 | |
|---|---|
| Type | Description |
long |
The softMaxMeters. |
hasCostPerKilometerAboveSoftMax()
publicbooleanhasCostPerKilometerAboveSoftMax() 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 | |
|---|---|
| Type | Description |
boolean |
Whether the costPerKilometerAboveSoftMax field is set. |
hasMaxMeters()
publicbooleanhasMaxMeters()A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.
optional int64 max_meters = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxMeters field is set. |
hasSoftMaxMeters()
publicbooleanhasSoftMaxMeters()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 | |
|---|---|
| Type | Description |
boolean |
Whether the softMaxMeters field is set. |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
publicfinalbooleanisInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(DistanceLimit other)
publicDistanceLimit.BuildermergeFrom(DistanceLimitother)| Parameter | |
|---|---|
| Name | Description |
other |
DistanceLimit |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicDistanceLimit.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
publicDistanceLimit.BuildermergeFrom(Messageother)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalDistanceLimit.BuildermergeUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
setCostPerKilometerAboveSoftMax(double value)
publicDistanceLimit.BuildersetCostPerKilometerAboveSoftMax(doublevalue) 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 | |
|---|---|
| Name | Description |
value |
double The costPerKilometerAboveSoftMax to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
publicDistanceLimit.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
setMaxMeters(long value)
publicDistanceLimit.BuildersetMaxMeters(longvalue)A hard limit constraining the distance to be at most max_meters. The limit must be nonnegative.
optional int64 max_meters = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
long The maxMeters to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicDistanceLimit.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|
setSoftMaxMeters(long value)
publicDistanceLimit.BuildersetSoftMaxMeters(longvalue)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 | |
|---|---|
| Name | Description |
value |
long The softMaxMeters to set. |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalDistanceLimit.BuildersetUnknownFields(UnknownFieldSetunknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DistanceLimit.Builder |
|