public static final class TimeWindow.Builder extends GeneratedMessageV3.Builder<TimeWindow.Builder> implements TimeWindowOrBuilderTime windows constrain the time of an event, such as the arrival time at a visit, or the start and end time of a vehicle.
Hard time window bounds, start_time and end_time, enforce the earliest
and latest time of the event, such that start_time <= event_time <=
end_time. The soft time window lower bound, soft_start_time, expresses a
preference for the event to happen at or after soft_start_time by incurring
a cost proportional to how long before soft_start_time the event occurs. The
soft time window upper bound, soft_end_time, expresses a preference for the
event to happen at or before soft_end_time by incurring a cost proportional
to how long after soft_end_time the event occurs. start_time, end_time,
soft_start_time and soft_end_time should be within the global time limits
(see
ShipmentModel.global_start_time
and
ShipmentModel.global_end_time)
and should respect:
<code><code>
0 <= </code>start_time<code> <= </code>soft_start_time<code> <= </code>end_time<code> and
0 <= </code>start_time<code> <= </code>soft_end_time<code> <= </code>end_time<code>.
</code></code>
Protobuf type google.cloud.optimization.v1.TimeWindow
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TimeWindow.BuilderImplements
TimeWindowOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TimeWindow.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
build()
public TimeWindow build()| Returns | |
|---|---|
| Type | Description |
TimeWindow |
|
buildPartial()
public TimeWindow buildPartial()| Returns | |
|---|---|
| Type | Description |
TimeWindow |
|
clear()
public TimeWindow.Builder clear()| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearCostPerHourAfterSoftEndTime()
public TimeWindow.Builder clearCostPerHourAfterSoftEndTime() A cost per hour added to other costs in the model if the event occurs after
soft_end_time, computed as:
`
max(0, t.seconds - soft_end_time.seconds)
cost_per_hour_after_soft_end_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if
soft_end_time` has been set.
optional double cost_per_hour_after_soft_end_time = 6;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
This builder for chaining. |
clearCostPerHourBeforeSoftStartTime()
public TimeWindow.Builder clearCostPerHourBeforeSoftStartTime()A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:
`
max(0, soft_start_time - t.seconds)
cost_per_hour_before_soft_start_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if soft_start_time has been set.
optional double cost_per_hour_before_soft_start_time = 5;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
This builder for chaining. |
clearEndTime()
public TimeWindow.Builder clearEndTime() The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public TimeWindow.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public TimeWindow.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearSoftEndTime()
public TimeWindow.Builder clearSoftEndTime()The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearSoftStartTime()
public TimeWindow.Builder clearSoftStartTime()The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clearStartTime()
public TimeWindow.Builder clearStartTime() The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
clone()
public TimeWindow.Builder clone()| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
getCostPerHourAfterSoftEndTime()
public double getCostPerHourAfterSoftEndTime() A cost per hour added to other costs in the model if the event occurs after
soft_end_time, computed as:
`
max(0, t.seconds - soft_end_time.seconds)
cost_per_hour_after_soft_end_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if
soft_end_time` has been set.
optional double cost_per_hour_after_soft_end_time = 6;
| Returns | |
|---|---|
| Type | Description |
double |
The costPerHourAfterSoftEndTime. |
getCostPerHourBeforeSoftStartTime()
public double getCostPerHourBeforeSoftStartTime()A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:
`
max(0, soft_start_time - t.seconds)
cost_per_hour_before_soft_start_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if soft_start_time has been set.
optional double cost_per_hour_before_soft_start_time = 5;
| Returns | |
|---|---|
| Type | Description |
double |
The costPerHourBeforeSoftStartTime. |
getDefaultInstanceForType()
public TimeWindow getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TimeWindow |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEndTime()
public Timestamp getEndTime() The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The endTime. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder() The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getEndTimeOrBuilder()
public TimestampOrBuilder getEndTimeOrBuilder() The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getSoftEndTime()
public Timestamp getSoftEndTime()The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The softEndTime. |
getSoftEndTimeBuilder()
public Timestamp.Builder getSoftEndTimeBuilder()The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getSoftEndTimeOrBuilder()
public TimestampOrBuilder getSoftEndTimeOrBuilder()The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getSoftStartTime()
public Timestamp getSoftStartTime()The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The softStartTime. |
getSoftStartTimeBuilder()
public Timestamp.Builder getSoftStartTimeBuilder()The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getSoftStartTimeOrBuilder()
public TimestampOrBuilder getSoftStartTimeOrBuilder()The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getStartTime()
public Timestamp getStartTime() The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The startTime. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder() The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getStartTimeOrBuilder()
public TimestampOrBuilder getStartTimeOrBuilder() The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCostPerHourAfterSoftEndTime()
public boolean hasCostPerHourAfterSoftEndTime() A cost per hour added to other costs in the model if the event occurs after
soft_end_time, computed as:
`
max(0, t.seconds - soft_end_time.seconds)
cost_per_hour_after_soft_end_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if
soft_end_time` has been set.
optional double cost_per_hour_after_soft_end_time = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costPerHourAfterSoftEndTime field is set. |
hasCostPerHourBeforeSoftStartTime()
public boolean hasCostPerHourBeforeSoftStartTime()A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:
`
max(0, soft_start_time - t.seconds)
cost_per_hour_before_soft_start_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if soft_start_time has been set.
optional double cost_per_hour_before_soft_start_time = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costPerHourBeforeSoftStartTime field is set. |
hasEndTime()
public boolean hasEndTime() The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the endTime field is set. |
hasSoftEndTime()
public boolean hasSoftEndTime()The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softEndTime field is set. |
hasSoftStartTime()
public boolean hasSoftStartTime()The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the softStartTime field is set. |
hasStartTime()
public boolean hasStartTime() The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEndTime(Timestamp value)
public TimeWindow.Builder mergeEndTime(Timestamp value) The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeFrom(TimeWindow other)
public TimeWindow.Builder mergeFrom(TimeWindow other)| Parameter | |
|---|---|
| Name | Description |
other |
TimeWindow |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TimeWindow.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TimeWindow.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeSoftEndTime(Timestamp value)
public TimeWindow.Builder mergeSoftEndTime(Timestamp value)The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeSoftStartTime(Timestamp value)
public TimeWindow.Builder mergeSoftStartTime(Timestamp value)The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeStartTime(Timestamp value)
public TimeWindow.Builder mergeStartTime(Timestamp value) The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TimeWindow.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setCostPerHourAfterSoftEndTime(double value)
public TimeWindow.Builder setCostPerHourAfterSoftEndTime(double value) A cost per hour added to other costs in the model if the event occurs after
soft_end_time, computed as:
`
max(0, t.seconds - soft_end_time.seconds)
cost_per_hour_after_soft_end_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if
soft_end_time` has been set.
optional double cost_per_hour_after_soft_end_time = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe costPerHourAfterSoftEndTime to set. |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
This builder for chaining. |
setCostPerHourBeforeSoftStartTime(double value)
public TimeWindow.Builder setCostPerHourBeforeSoftStartTime(double value)A cost per hour added to other costs in the model if the event occurs before soft_start_time, computed as:
`
max(0, soft_start_time - t.seconds)
cost_per_hour_before_soft_start_time / 3600, t being the time of the event.
This cost must be positive, and the field can only be set if soft_start_time has been set.
optional double cost_per_hour_before_soft_start_time = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe costPerHourBeforeSoftStartTime to set. |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
This builder for chaining. |
setEndTime(Timestamp value)
public TimeWindow.Builder setEndTime(Timestamp value) The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setEndTime(Timestamp.Builder builderForValue)
public TimeWindow.Builder setEndTime(Timestamp.Builder builderForValue) The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public TimeWindow.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TimeWindow.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setSoftEndTime(Timestamp value)
public TimeWindow.Builder setSoftEndTime(Timestamp value)The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setSoftEndTime(Timestamp.Builder builderForValue)
public TimeWindow.Builder setSoftEndTime(Timestamp.Builder builderForValue)The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setSoftStartTime(Timestamp value)
public TimeWindow.Builder setSoftStartTime(Timestamp value)The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setSoftStartTime(Timestamp.Builder builderForValue)
public TimeWindow.Builder setSoftStartTime(Timestamp.Builder builderForValue)The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setStartTime(Timestamp value)
public TimeWindow.Builder setStartTime(Timestamp value) The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setStartTime(Timestamp.Builder builderForValue)
public TimeWindow.Builder setStartTime(Timestamp.Builder builderForValue) The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final TimeWindow.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TimeWindow.Builder |
|