Interface Shipment.VisitRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Shipment.VisitRequest, Shipment.VisitRequest.Builder
    Enclosing class:
    Shipment

    public static interface Shipment.VisitRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • hasArrivalLocation

        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:
        Whether the arrivalLocation field is set.
      • getArrivalLocation

        com.google.type.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:
        The arrivalLocation.
      • getArrivalLocationOrBuilder

        com.google.type.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;
      • hasArrivalWaypoint

        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:
        Whether the arrivalWaypoint field is set.
      • getArrivalWaypoint

        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:
        The arrivalWaypoint.
      • getArrivalWaypointOrBuilder

        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;
      • hasDepartureLocation

        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:
        Whether the departureLocation field is set.
      • getDepartureLocation

        com.google.type.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:
        The departureLocation.
      • getDepartureLocationOrBuilder

        com.google.type.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;
      • hasDepartureWaypoint

        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:
        Whether the departureWaypoint field is set.
      • getDepartureWaypoint

        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:
        The departureWaypoint.
      • getDepartureWaypointOrBuilder

        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;
      • getTagsList

        List<String> getTagsList()
         Specifies tags attached to the visit request.
         Empty or duplicate strings are not allowed.
         
        repeated string tags = 5;
        Returns:
        A list containing the tags.
      • getTagsCount

        int getTagsCount()
         Specifies tags attached to the visit request.
         Empty or duplicate strings are not allowed.
         
        repeated string tags = 5;
        Returns:
        The count of tags.
      • getTags

        String getTags​(int index)
         Specifies tags attached to the visit request.
         Empty or duplicate strings are not allowed.
         
        repeated string tags = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The tags at the given index.
      • getTagsBytes

        com.google.protobuf.ByteString getTagsBytes​(int index)
         Specifies tags attached to the visit request.
         Empty or duplicate strings are not allowed.
         
        repeated string tags = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the tags at the given index.
      • getTimeWindowsList

        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][google.cloud.optimization.v1.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;
      • getTimeWindows

        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][google.cloud.optimization.v1.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;
      • getTimeWindowsCount

        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][google.cloud.optimization.v1.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;
      • getTimeWindowsOrBuilderList

        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][google.cloud.optimization.v1.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;
      • getTimeWindowsOrBuilder

        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][google.cloud.optimization.v1.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;
      • hasDuration

        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:
        Whether the duration field is set.
      • getDuration

        com.google.protobuf.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:
        The duration.
      • getDurationOrBuilder

        com.google.protobuf.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;
      • getCost

        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:
        The cost.
      • getLoadDemandsCount

        int getLoadDemandsCount()
         Load demands of this visit request. This is just like
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
         field, except that it only applies to this
         [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest]
         instead of the whole [Shipment][google.cloud.optimization.v1.Shipment].
         The demands listed here are added to the demands listed in
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
         
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
      • containsLoadDemands

        boolean containsLoadDemands​(String key)
         Load demands of this visit request. This is just like
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
         field, except that it only applies to this
         [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest]
         instead of the whole [Shipment][google.cloud.optimization.v1.Shipment].
         The demands listed here are added to the demands listed in
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
         
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
      • getLoadDemandsMap

        Map<String,​Shipment.Load> getLoadDemandsMap()
         Load demands of this visit request. This is just like
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
         field, except that it only applies to this
         [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest]
         instead of the whole [Shipment][google.cloud.optimization.v1.Shipment].
         The demands listed here are added to the demands listed in
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
         
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
      • getLoadDemandsOrDefault

        Shipment.Load getLoadDemandsOrDefault​(String key,
                                              Shipment.Load defaultValue)
         Load demands of this visit request. This is just like
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
         field, except that it only applies to this
         [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest]
         instead of the whole [Shipment][google.cloud.optimization.v1.Shipment].
         The demands listed here are added to the demands listed in
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
         
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
      • getLoadDemandsOrThrow

        Shipment.Load getLoadDemandsOrThrow​(String key)
         Load demands of this visit request. This is just like
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands]
         field, except that it only applies to this
         [VisitRequest][google.cloud.optimization.v1.Shipment.VisitRequest]
         instead of the whole [Shipment][google.cloud.optimization.v1.Shipment].
         The demands listed here are added to the demands listed in
         [Shipment.load_demands][google.cloud.optimization.v1.Shipment.load_demands].
         
        map<string, .google.cloud.optimization.v1.Shipment.Load> load_demands = 12;
      • getVisitTypesList

        List<String> 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][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]).
        
         A type can only appear once.
         
        repeated string visit_types = 10;
        Returns:
        A list containing the visitTypes.
      • getVisitTypesCount

        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][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]).
        
         A type can only appear once.
         
        repeated string visit_types = 10;
        Returns:
        The count of visitTypes.
      • getVisitTypes

        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][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]).
        
         A type can only appear once.
         
        repeated string visit_types = 10;
        Parameters:
        index - The index of the element to return.
        Returns:
        The visitTypes at the given index.
      • getVisitTypesBytes

        com.google.protobuf.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][google.cloud.optimization.v1.Vehicle.extra_visit_duration_for_visit_type]).
        
         A type can only appear once.
         
        repeated string visit_types = 10;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the visitTypes at the given index.
      • getLabel

        String getLabel()
         Specifies a label for this `VisitRequest`. This label is reported in the
         response as `visit_label` in the corresponding
         [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit].
         
        string label = 11;
        Returns:
        The label.
      • getLabelBytes

        com.google.protobuf.ByteString getLabelBytes()
         Specifies a label for this `VisitRequest`. This label is reported in the
         response as `visit_label` in the corresponding
         [ShipmentRoute.Visit][google.cloud.optimization.v1.ShipmentRoute.Visit].
         
        string label = 11;
        Returns:
        The bytes for label.
      • getDemandsList

        @Deprecated
        List<CapacityQuantity> getDemandsList()
        Deprecated.
         Deprecated: Use
         [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands]
         instead.
         
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
      • getDemands

        @Deprecated
        CapacityQuantity getDemands​(int index)
        Deprecated.
         Deprecated: Use
         [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands]
         instead.
         
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
      • getDemandsCount

        @Deprecated
        int getDemandsCount()
        Deprecated.
         Deprecated: Use
         [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands]
         instead.
         
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
      • getDemandsOrBuilderList

        @Deprecated
        List<? extends CapacityQuantityOrBuilder> getDemandsOrBuilderList()
        Deprecated.
         Deprecated: Use
         [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands]
         instead.
         
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];
      • getDemandsOrBuilder

        @Deprecated
        CapacityQuantityOrBuilder getDemandsOrBuilder​(int index)
        Deprecated.
         Deprecated: Use
         [VisitRequest.load_demands][google.cloud.optimization.v1.Shipment.VisitRequest.load_demands]
         instead.
         
        repeated .google.cloud.optimization.v1.CapacityQuantity demands = 9 [deprecated = true];