Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class TimeWindow (1.13.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 <= </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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TimeWindow

Implements

TimeWindowOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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
Type	Description
`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
Type	Description
`int`

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

SOFT_END_TIME_FIELD_NUMBER

public static final int SOFT_END_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

SOFT_START_TIME_FIELD_NUMBER

public static final int SOFT_START_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static TimeWindow getDefaultInstance()

Returns
Type	Description
`TimeWindow`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static TimeWindow.Builder newBuilder()

Returns
Type	Description
`TimeWindow.Builder`

newBuilder(TimeWindow prototype)

public static TimeWindow.Builder newBuilder(TimeWindow prototype)

Parameter
Name	Description
`prototype`	`TimeWindow`

Returns
Type	Description
`TimeWindow.Builder`

parseDelimitedFrom(InputStream input)

public static TimeWindow parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static TimeWindow parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static TimeWindow parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static TimeWindow parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static TimeWindow parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static TimeWindow parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TimeWindow parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TimeWindow`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<TimeWindow> parser()

Returns
Type	Description
`Parser<TimeWindow>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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`

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.

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`

getParserForType()

public Parser<TimeWindow> getParserForType()

Returns
Type	Description
`Parser<TimeWindow>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

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.

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`

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns
Type	Description
`UnknownFieldSet`

Overrides

GeneratedMessageV3.getUnknownFields()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TimeWindow.Builder newBuilderForType()

Returns
Type	Description
`TimeWindow.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TimeWindow.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`TimeWindow.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TimeWindow.Builder toBuilder()

Returns
Type	Description
`TimeWindow.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`