publicfinalclass TimeWindowextendsGeneratedMessageV3implementsTimeWindowOrBuilder
Time 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COST_PER_HOUR_AFTER_SOFT_END_TIME_FIELD_NUMBER
publicstaticfinalintCOST_PER_HOUR_AFTER_SOFT_END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
COST_PER_HOUR_BEFORE_SOFT_START_TIME_FIELD_NUMBER
publicstaticfinalintCOST_PER_HOUR_BEFORE_SOFT_START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
END_TIME_FIELD_NUMBER
publicstaticfinalintEND_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SOFT_END_TIME_FIELD_NUMBER
publicstaticfinalintSOFT_END_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
SOFT_START_TIME_FIELD_NUMBER
publicstaticfinalintSOFT_START_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
START_TIME_FIELD_NUMBER
publicstaticfinalintSTART_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticTimeWindowgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticTimeWindow.BuildernewBuilder()
newBuilder(TimeWindow prototype)
publicstaticTimeWindow.BuildernewBuilder(TimeWindowprototype)
publicstaticTimeWindowparseDelimitedFrom(InputStreaminput)
publicstaticTimeWindowparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticTimeWindowparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticTimeWindowparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticTimeWindowparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticTimeWindowparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticTimeWindowparseFrom(CodedInputStreaminput)
publicstaticTimeWindowparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticTimeWindowparseFrom(InputStreaminput)
publicstaticTimeWindowparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticTimeWindowparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticTimeWindowparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<TimeWindow>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getCostPerHourAfterSoftEndTime()
publicdoublegetCostPerHourAfterSoftEndTime()
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()
publicdoublegetCostPerHourBeforeSoftStartTime()
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()
publicTimeWindowgetDefaultInstanceForType()
getEndTime()
publicTimestampgetEndTime()
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.
|
getEndTimeOrBuilder()
publicTimestampOrBuildergetEndTimeOrBuilder()
The hard time window end time. If unspecified it will be set to
ShipmentModel.global_end_time.
.google.protobuf.Timestamp end_time = 2;
getParserForType()
publicParser<TimeWindow>getParserForType()
Overrides
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getSoftEndTime()
publicTimestampgetSoftEndTime()
The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
| Returns |
| Type |
Description |
Timestamp |
The softEndTime.
|
getSoftEndTimeOrBuilder()
publicTimestampOrBuildergetSoftEndTimeOrBuilder()
The soft end time of the time window.
.google.protobuf.Timestamp soft_end_time = 4;
getSoftStartTime()
publicTimestampgetSoftStartTime()
The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
| Returns |
| Type |
Description |
Timestamp |
The softStartTime.
|
getSoftStartTimeOrBuilder()
publicTimestampOrBuildergetSoftStartTimeOrBuilder()
The soft start time of the time window.
.google.protobuf.Timestamp soft_start_time = 3;
getStartTime()
publicTimestampgetStartTime()
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.
|
getStartTimeOrBuilder()
publicTimestampOrBuildergetStartTimeOrBuilder()
The hard time window start time. If unspecified it will be set to
ShipmentModel.global_start_time.
.google.protobuf.Timestamp start_time = 1;
hasCostPerHourAfterSoftEndTime()
publicbooleanhasCostPerHourAfterSoftEndTime()
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()
publicbooleanhasCostPerHourBeforeSoftStartTime()
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()
publicbooleanhasEndTime()
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()
publicbooleanhasSoftEndTime()
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()
publicbooleanhasSoftStartTime()
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()
publicbooleanhasStartTime()
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
Overrides
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicTimeWindow.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedTimeWindow.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicTimeWindow.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides