Class TimeWindow (1.32.0)

public final class TimeWindow extends GeneratedMessageV3 implements TimeWindowOrBuilder

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 &lt;= </code>start_time<code> &lt;= </code>soft_start_time<code> &lt;= </code>end_time<code> and 0 &lt;= </code>start_time<code> &lt;= </code>soft_end_time<code> &lt;= </code>end_time<code>. </code></code>

Protobuf type google.cloud.optimization.v1.TimeWindow

Implements

TimeWindowOrBuilder

Static Fields

COST_PER_HOUR_AFTER_SOFT_END_TIME_FIELD_NUMBER

public static final int COST_PER_HOUR_AFTER_SOFT_END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

COST_PER_HOUR_BEFORE_SOFT_START_TIME_FIELD_NUMBER

public static final int COST_PER_HOUR_BEFORE_SOFT_START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SOFT_END_TIME_FIELD_NUMBER

public static final int SOFT_END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

SOFT_START_TIME_FIELD_NUMBER

public static final int SOFT_START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TimeWindow getDefaultInstance()
Returns
TypeDescription
TimeWindow

getDescriptor()

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

newBuilder()

public static TimeWindow.Builder newBuilder()
Returns
TypeDescription
TimeWindow.Builder

newBuilder(TimeWindow prototype)

public static TimeWindow.Builder newBuilder(TimeWindow prototype)
Parameter
NameDescription
prototypeTimeWindow
Returns
TypeDescription
TimeWindow.Builder

parseDelimitedFrom(InputStream input)

public static TimeWindow parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TimeWindow parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TimeWindow parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TimeWindow parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TimeWindow parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TimeWindow parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeWindow
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TimeWindow> parser()
Returns
TypeDescription
Parser<TimeWindow>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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
TypeDescription
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
TypeDescription
double

The costPerHourBeforeSoftStartTime.

getDefaultInstanceForType()

public TimeWindow getDefaultInstanceForType()
Returns
TypeDescription
TimeWindow

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
TypeDescription
Timestamp

The endTime.

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
TypeDescription
TimestampOrBuilder

getParserForType()

public Parser<TimeWindow> getParserForType()
Returns
TypeDescription
Parser<TimeWindow>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSoftEndTime()

public Timestamp getSoftEndTime()

The soft end time of the time window.

.google.protobuf.Timestamp soft_end_time = 4;

Returns
TypeDescription
Timestamp

The softEndTime.

getSoftEndTimeOrBuilder()

public TimestampOrBuilder getSoftEndTimeOrBuilder()

The soft end time of the time window.

.google.protobuf.Timestamp soft_end_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getSoftStartTime()

public Timestamp getSoftStartTime()

The soft start time of the time window.

.google.protobuf.Timestamp soft_start_time = 3;

Returns
TypeDescription
Timestamp

The softStartTime.

getSoftStartTimeOrBuilder()

public TimestampOrBuilder getSoftStartTimeOrBuilder()

The soft start time of the time window.

.google.protobuf.Timestamp soft_start_time = 3;

Returns
TypeDescription
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
TypeDescription
Timestamp

The startTime.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TimeWindow.Builder newBuilderForType()
Returns
TypeDescription
TimeWindow.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TimeWindow.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TimeWindow.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TimeWindow.Builder toBuilder()
Returns
TypeDescription
TimeWindow.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException