Class Shipment.VisitRequest (1.47.0)

Version 1.47.0

• 1.51.0 (latest)
• 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

public static final class Shipment.VisitRequest extends GeneratedMessageV3 implements Shipment.VisitRequestOrBuilder

Request for a visit which can be done by a vehicle: it has a geo-location (or two, see below), opening and closing times represented by time windows, and a service duration time (time spent by the vehicle once it has arrived to pickup or drop off goods).

Protobuf type google.cloud.optimization.v1.Shipment.VisitRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Shipment.VisitRequest

Implements

Shipment.VisitRequestOrBuilder

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)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

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)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

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)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(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

ARRIVAL_LOCATION_FIELD_NUMBER

public static final int ARRIVAL_LOCATION_FIELD_NUMBER

Field Value
Type	Description
int

ARRIVAL_WAYPOINT_FIELD_NUMBER

public static final int ARRIVAL_WAYPOINT_FIELD_NUMBER

Field Value
Type	Description
int

COST_FIELD_NUMBER

public static final int COST_FIELD_NUMBER

Field Value
Type	Description
int

DEMANDS_FIELD_NUMBER

public static final int DEMANDS_FIELD_NUMBER

Field Value
Type	Description
int

DEPARTURE_LOCATION_FIELD_NUMBER

public static final int DEPARTURE_LOCATION_FIELD_NUMBER

Field Value
Type	Description
int

DEPARTURE_WAYPOINT_FIELD_NUMBER

public static final int DEPARTURE_WAYPOINT_FIELD_NUMBER

Field Value
Type	Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER

Field Value
Type	Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER

Field Value
Type	Description
int

LOAD_DEMANDS_FIELD_NUMBER

public static final int LOAD_DEMANDS_FIELD_NUMBER

Field Value
Type	Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER

Field Value
Type	Description
int

TIME_WINDOWS_FIELD_NUMBER

public static final int TIME_WINDOWS_FIELD_NUMBER

Field Value
Type	Description
int

VISIT_TYPES_FIELD_NUMBER

public static final int VISIT_TYPES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Shipment.VisitRequest getDefaultInstance()

Returns
Type	Description
Shipment.VisitRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Shipment.VisitRequest.Builder newBuilder()

Returns
Type	Description
Shipment.VisitRequest.Builder

newBuilder(Shipment.VisitRequest prototype)

public static Shipment.VisitRequest.Builder newBuilder(Shipment.VisitRequest prototype)

Parameter
Name	Description
prototype	Shipment.VisitRequest

Returns
Type	Description
Shipment.VisitRequest.Builder

parseDelimitedFrom(InputStream input)

public static Shipment.VisitRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Shipment.VisitRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Shipment.VisitRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Shipment.VisitRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Shipment.VisitRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Shipment.VisitRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Shipment.VisitRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Shipment.VisitRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Shipment.VisitRequest> parser()

Returns
Type	Description
Parser<VisitRequest>

Methods

containsLoadDemands(String key)

public boolean containsLoadDemands(String key)

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.

map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getArrivalLocation()

public LatLng getArrivalLocation()

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

.google.type.LatLng arrival_location = 1;

Returns
Type	Description
com.google.type.LatLng	The arrivalLocation.

getArrivalLocationOrBuilder()

public LatLngOrBuilder getArrivalLocationOrBuilder()

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

.google.type.LatLng arrival_location = 1;

Returns
Type	Description
com.google.type.LatLngOrBuilder

getArrivalWaypoint()

public Waypoint getArrivalWaypoint()

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;

Returns
Type	Description
Waypoint	The arrivalWaypoint.

getArrivalWaypointOrBuilder()

public WaypointOrBuilder getArrivalWaypointOrBuilder()

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;

Returns
Type	Description
WaypointOrBuilder

getCost()

public double getCost()

Cost to service this visit request on a vehicle route. This can be used to pay different costs for each alternative pickup or delivery of a shipment. This cost must be in the same unit as Shipment.penalty_cost and must not be negative.

double cost = 8;

Returns
Type	Description
double	The cost.

getDefaultInstanceForType()

public Shipment.VisitRequest getDefaultInstanceForType()

Returns
Type	Description
Shipment.VisitRequest

getDemands(int index) (deprecated)

public CapacityQuantity getDemands(int index)

Deprecated: Use VisitRequest.load_demands instead.

repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
CapacityQuantity

getDemandsCount() (deprecated)

public int getDemandsCount()

Deprecated: Use VisitRequest.load_demands instead.

repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];

Returns
Type	Description
int

getDemandsList() (deprecated)

public List<CapacityQuantity> getDemandsList()

Deprecated: Use VisitRequest.load_demands instead.

repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];

Returns
Type	Description
List<CapacityQuantity>

getDemandsOrBuilder(int index) (deprecated)

public CapacityQuantityOrBuilder getDemandsOrBuilder(int index)

Deprecated: Use VisitRequest.load_demands instead.

repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];

Parameter
Name	Description
index	int

Returns
Type	Description
CapacityQuantityOrBuilder

getDemandsOrBuilderList() (deprecated)

public List<? extends CapacityQuantityOrBuilder> getDemandsOrBuilderList()

Deprecated: Use VisitRequest.load_demands instead.

repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.CapacityQuantityOrBuilder>

getDepartureLocation()

public LatLng getDepartureLocation()

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location. If the shipment model has duration distance matrices, departure_location must not be specified.

.google.type.LatLng departure_location = 3;

Returns
Type	Description
com.google.type.LatLng	The departureLocation.

getDepartureLocationOrBuilder()

public LatLngOrBuilder getDepartureLocationOrBuilder()

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location. If the shipment model has duration distance matrices, departure_location must not be specified.

.google.type.LatLng departure_location = 3;

Returns
Type	Description
com.google.type.LatLngOrBuilder

getDepartureWaypoint()

public Waypoint getDepartureWaypoint()

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint. If the shipment model has duration distance matrices, departure_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;

Returns
Type	Description
Waypoint	The departureWaypoint.

getDepartureWaypointOrBuilder()

public WaypointOrBuilder getDepartureWaypointOrBuilder()

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint. If the shipment model has duration distance matrices, departure_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;

Returns
Type	Description
WaypointOrBuilder

getDuration()

public Duration getDuration()

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

.google.protobuf.Duration duration = 7;

Returns
Type	Description
Duration	The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

.google.protobuf.Duration duration = 7;

Returns
Type	Description
DurationOrBuilder

getLabel()

public String getLabel()

Specifies a label for this VisitRequest. This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit.

string label = 11;

Returns
Type	Description
String	The label.

getLabelBytes()

public ByteString getLabelBytes()

Specifies a label for this VisitRequest. This label is reported in the response as visit_label in the corresponding ShipmentRoute.Visit.

string label = 11;

Returns
Type	Description
ByteString	The bytes for label.

getLoadDemands() (deprecated)

public Map<String,Shipment.Load> getLoadDemands()

Use #getLoadDemandsMap() instead.

Returns
Type	Description
Map<String,Load>

getLoadDemandsCount()

public int getLoadDemandsCount()

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.

map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;

Returns
Type	Description
int

getLoadDemandsMap()

public Map<String,Shipment.Load> getLoadDemandsMap()

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.

map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;

Returns
Type	Description
Map<String,Load>

getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)

public Shipment.Load getLoadDemandsOrDefault(String key, Shipment.Load defaultValue)

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.

map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;

Parameters
Name	Description
key	String
defaultValue	Shipment.Load

Returns
Type	Description
Shipment.Load

getLoadDemandsOrThrow(String key)

public Shipment.Load getLoadDemandsOrThrow(String key)

Load demands of this visit request. This is just like Shipment.load_demands field, except that it only applies to this VisitRequest instead of the whole Shipment. The demands listed here are added to the demands listed in Shipment.load_demands.

map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;

Parameter
Name	Description
key	String

Returns
Type	Description
Shipment.Load

getParserForType()

public Parser<Shipment.VisitRequest> getParserForType()

Returns
Type	Description
Parser<VisitRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTags(int index)

public String getTags(int index)

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

repeated string tags = 5;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

repeated string tags = 5;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

repeated string tags = 5;

Returns
Type	Description
int	The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

Specifies tags attached to the visit request. Empty or duplicate strings are not allowed.

repeated string tags = 5;

Returns
Type	Description
ProtocolStringList	A list containing the tags.

getTimeWindows(int index)

public TimeWindow getTimeWindows(int index)

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time.

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow time_windows = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
TimeWindow

getTimeWindowsCount()

public int getTimeWindowsCount()

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time.

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow time_windows = 6;

Returns
Type	Description
int

getTimeWindowsList()

public List<TimeWindow> getTimeWindowsList()

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time.

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow time_windows = 6;

Returns
Type	Description
List<TimeWindow>

getTimeWindowsOrBuilder(int index)

public TimeWindowOrBuilder getTimeWindowsOrBuilder(int index)

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time.

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow time_windows = 6;

Parameter
Name	Description
index	int

Returns
Type	Description
TimeWindowOrBuilder

getTimeWindowsOrBuilderList()

public List<? extends TimeWindowOrBuilder> getTimeWindowsOrBuilderList()

Time windows which constrain the arrival time at a visit. Note that a vehicle may depart outside of the arrival time window, i.e. arrival time + duration do not need to be inside a time window. This can result in waiting time if the vehicle arrives before TimeWindow.start_time.

The absence of TimeWindow means that the vehicle can perform this visit at any time.

Time windows must be disjoint, i.e. no time window must overlap with or be adjacent to another, and they must be in increasing order.

cost_per_hour_after_soft_end_time and soft_end_time can only be set if there is a single time window.

repeated .google.cloud.optimization.v1.TimeWindow time_windows = 6;

Returns
Type	Description
List<? extends com.google.cloud.optimization.v1.TimeWindowOrBuilder>

getVisitTypes(int index)

public String getVisitTypes(int index)

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

repeated string visit_types = 10;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The visitTypes at the given index.

getVisitTypesBytes(int index)

public ByteString getVisitTypesBytes(int index)

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

repeated string visit_types = 10;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the visitTypes at the given index.

getVisitTypesCount()

public int getVisitTypesCount()

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

repeated string visit_types = 10;

Returns
Type	Description
int	The count of visitTypes.

getVisitTypesList()

public ProtocolStringList getVisitTypesList()

Specifies the types of the visit. This may be used to allocate additional time required for a vehicle to complete this visit (see Vehicle.extra_visit_duration_for_visit_type).

A type can only appear once.

repeated string visit_types = 10;

Returns
Type	Description
ProtocolStringList	A list containing the visitTypes.

hasArrivalLocation()

public boolean hasArrivalLocation()

The geo-location where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_location must not be specified.

.google.type.LatLng arrival_location = 1;

Returns
Type	Description
boolean	Whether the arrivalLocation field is set.

hasArrivalWaypoint()

public boolean hasArrivalWaypoint()

The waypoint where the vehicle arrives when performing this VisitRequest. If the shipment model has duration distance matrices, arrival_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint arrival_waypoint = 2;

Returns
Type	Description
boolean	Whether the arrivalWaypoint field is set.

hasDepartureLocation()

public boolean hasDepartureLocation()

The geo-location where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_location. If the shipment model has duration distance matrices, departure_location must not be specified.

.google.type.LatLng departure_location = 3;

Returns
Type	Description
boolean	Whether the departureLocation field is set.

hasDepartureWaypoint()

public boolean hasDepartureWaypoint()

The waypoint where the vehicle departs after completing this VisitRequest. Can be omitted if it is the same as arrival_waypoint. If the shipment model has duration distance matrices, departure_waypoint must not be specified.

.google.cloud.optimization.v1.Waypoint departure_waypoint = 4;

Returns
Type	Description
boolean	Whether the departureWaypoint field is set.

hasDuration()

public boolean hasDuration()

Duration of the visit, i.e. time spent by the vehicle between arrival and departure (to be added to the possible waiting time; see time_windows).

.google.protobuf.Duration duration = 7;

Returns
Type	Description
boolean	Whether the duration 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()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Shipment.VisitRequest.Builder newBuilderForType()

Returns
Type	Description
Shipment.VisitRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Shipment.VisitRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Shipment.VisitRequest.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 Shipment.VisitRequest.Builder toBuilder()

Returns
Type	Description
Shipment.VisitRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException