Package com.google.cloud.optimization.v1 (1.30.0)
| GitHub Repository | RPC Documentation | REST Documentation |
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com.google.cloud.optimization.v1.FleetRoutingClient |
Service Description: A service for optimizing vehicle tours.
Validity of certain types of fields: |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com.google.cloud.optimization.v1.FleetRoutingSettings |
Settings class to configure an instance of FleetRoutingClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com.google.cloud.optimization.v1.AggregatedMetrics | Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse |
| com.google.cloud.optimization.v1.AggregatedMetrics.Builder | Aggregated metrics for ShipmentRoute (resp. for OptimizeToursResponse |
| com.google.cloud.optimization.v1.AsyncModelMetadata | The long running operation metadata for async model related methods. |
| com.google.cloud.optimization.v1.AsyncModelMetadata.Builder | The long running operation metadata for async model related methods. |
| com.google.cloud.optimization.v1.AsyncModelProto | |
| com.google.cloud.optimization.v1.BatchOptimizeToursRequest |
Request to batch optimize tours as an asynchronous operation.
Each input file should contain one OptimizeToursRequest, and each output
file will contain one OptimizeToursResponse. The request contains |
| com.google.cloud.optimization.v1.BatchOptimizeToursRequest.AsyncModelConfig | Information for solving one optimization model asynchronously. |
| com.google.cloud.optimization.v1.BatchOptimizeToursRequest.AsyncModelConfig.Builder | Information for solving one optimization model asynchronously. |
| com.google.cloud.optimization.v1.BatchOptimizeToursRequest.Builder |
Request to batch optimize tours as an asynchronous operation.
Each input file should contain one OptimizeToursRequest, and each output
file will contain one OptimizeToursResponse. The request contains |
| com.google.cloud.optimization.v1.BatchOptimizeToursResponse |
Response to a BatchOptimizeToursRequest. This is returned in
the LRO Operation after the operation is complete.
|
| com.google.cloud.optimization.v1.BatchOptimizeToursResponse.Builder |
Response to a BatchOptimizeToursRequest. This is returned in
the LRO Operation after the operation is complete.
|
| com.google.cloud.optimization.v1.BreakRule | Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur: |
| com.google.cloud.optimization.v1.BreakRule.BreakRequest |
The sequence of breaks (i.e. their number and order) that apply to each
vehicle must be known beforehand. The repeated BreakRequests define
that sequence, in the order in which they must occur. Their time windows |
| com.google.cloud.optimization.v1.BreakRule.BreakRequest.Builder |
The sequence of breaks (i.e. their number and order) that apply to each
vehicle must be known beforehand. The repeated BreakRequests define
that sequence, in the order in which they must occur. Their time windows |
| com.google.cloud.optimization.v1.BreakRule.Builder | Rules to generate time breaks for a vehicle (e.g. lunch breaks). A break is a contiguous period of time during which the vehicle remains idle at its current position and cannot perform any visit. A break may occur: |
| com.google.cloud.optimization.v1.BreakRule.FrequencyConstraint | One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that |
| com.google.cloud.optimization.v1.BreakRule.FrequencyConstraint.Builder | One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that |
| com.google.cloud.optimization.v1.CapacityQuantity | Deprecated: Use Vehicle.LoadLimit.Interval instead. |
| com.google.cloud.optimization.v1.CapacityQuantity.Builder | Deprecated: Use Vehicle.LoadLimit.Interval instead. |
| com.google.cloud.optimization.v1.CapacityQuantityInterval | Deprecated: Use Vehicle.LoadLimit.Interval instead. |
| com.google.cloud.optimization.v1.CapacityQuantityInterval.Builder | Deprecated: Use Vehicle.LoadLimit.Interval instead. |
| com.google.cloud.optimization.v1.DistanceLimit | A limit defining a maximum distance which can be traveled. It can be either hard or soft. |
| com.google.cloud.optimization.v1.DistanceLimit.Builder | A limit defining a maximum distance which can be traveled. It can be either hard or soft. |
| com.google.cloud.optimization.v1.FleetRoutingGrpc |
A service for optimizing vehicle tours.
Validity of certain types of fields:
* google.protobuf.Timestamp |
| com.google.cloud.optimization.v1.FleetRoutingGrpc.FleetRoutingImplBase | Base class for the server implementation of the service FleetRouting. A service for optimizing vehicle tours. |
| com.google.cloud.optimization.v1.FleetRoutingProto | |
| com.google.cloud.optimization.v1.FleetRoutingSettings.Builder | Builder for FleetRoutingSettings. |
| com.google.cloud.optimization.v1.GcsDestination | The Google Cloud Storage location where the output file will be written to. |
| com.google.cloud.optimization.v1.GcsDestination.Builder | The Google Cloud Storage location where the output file will be written to. |
| com.google.cloud.optimization.v1.GcsSource | The Google Cloud Storage location where the input file will be read from. |
| com.google.cloud.optimization.v1.GcsSource.Builder | The Google Cloud Storage location where the input file will be read from. |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint | Solution injected in the request including information about which visits must be constrained and how they must be constrained. |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.Builder | Solution injected in the request including information about which visits must be constrained and how they must be constrained. |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation |
For a group of vehicles, specifies at what threshold(s) constraints on
visits will be relaxed and to which level. Shipments listed in
the skipped_shipment field are constrained to be skipped; i.e., they |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.Builder |
For a group of vehicles, specifies at what threshold(s) constraints on
visits will be relaxed and to which level. Shipments listed in
the skipped_shipment field are constrained to be skipped; i.e., they |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.Relaxation |
If relaxations is empty, the start time and sequence of all visits
on routes are fully constrained and no new visits may be inserted or
added to those routes. Also, a vehicle's start and end time in |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.Relaxation.Builder |
If relaxations is empty, the start time and sequence of all visits
on routes are fully constrained and no new visits may be inserted or
added to those routes. Also, a vehicle's start and end time in |
| com.google.cloud.optimization.v1.InputConfig | The desired input location information. |
| com.google.cloud.optimization.v1.InputConfig.Builder | The desired input location information. |
| com.google.cloud.optimization.v1.Location | Encapsulates a location (a geographic point, and an optional heading). |
| com.google.cloud.optimization.v1.Location.Builder | Encapsulates a location (a geographic point, and an optional heading). |
| com.google.cloud.optimization.v1.OptimizeToursRequest | Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters. |
| com.google.cloud.optimization.v1.OptimizeToursRequest.Builder | Request to be given to a tour optimization solver which defines the shipment model to solve as well as optimization parameters. |
| com.google.cloud.optimization.v1.OptimizeToursResponse | Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution. |
| com.google.cloud.optimization.v1.OptimizeToursResponse.Builder | Response after solving a tour optimization problem containing the routes followed by each vehicle, the shipments which have been skipped and the overall cost of the solution. |
| com.google.cloud.optimization.v1.OptimizeToursResponse.Metrics | Overall metrics, aggregated over all routes. |
| com.google.cloud.optimization.v1.OptimizeToursResponse.Metrics.Builder | Overall metrics, aggregated over all routes. |
| com.google.cloud.optimization.v1.OptimizeToursValidationError |
Describes an error encountered when validating an OptimizeToursRequest.
|
| com.google.cloud.optimization.v1.OptimizeToursValidationError.Builder |
Describes an error encountered when validating an OptimizeToursRequest.
|
| com.google.cloud.optimization.v1.OptimizeToursValidationError.FieldReference |
Specifies a context for the validation error. A FieldReference always
refers to a given field in this file and follows the same hierarchical
structure. For example, we may specify element #2 of start_time_windows |
| com.google.cloud.optimization.v1.OptimizeToursValidationError.FieldReference.Builder |
Specifies a context for the validation error. A FieldReference always
refers to a given field in this file and follows the same hierarchical
structure. For example, we may specify element #2 of start_time_windows |
| com.google.cloud.optimization.v1.OutputConfig | The desired output location. |
| com.google.cloud.optimization.v1.OutputConfig.Builder | The desired output location. |
| com.google.cloud.optimization.v1.RouteModifiers |
Encapsulates a set of optional conditions to satisfy when calculating
vehicle routes. This is similar to RouteModifiers in the Google Maps
Platform API; see: |
| com.google.cloud.optimization.v1.RouteModifiers.Builder |
Encapsulates a set of optional conditions to satisfy when calculating
vehicle routes. This is similar to RouteModifiers in the Google Maps
Platform API; see: |
| com.google.cloud.optimization.v1.Shipment | The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities |
| com.google.cloud.optimization.v1.Shipment.Builder | The shipment of a single item, from one of its pickups to one of its deliveries. For the shipment to be considered as performed, a unique vehicle must visit one of its pickup locations (and decrease its spare capacities |
| com.google.cloud.optimization.v1.Shipment.Load | When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See |
| com.google.cloud.optimization.v1.Shipment.Load.Builder | When performing a visit, a predefined amount may be added to the vehicle load if it's a pickup, or subtracted if it's a delivery. This message defines such amount. See |
| com.google.cloud.optimization.v1.Shipment.VisitRequest | 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 |
| com.google.cloud.optimization.v1.Shipment.VisitRequest.Builder | 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 |
| com.google.cloud.optimization.v1.ShipmentModel | A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of: |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule | Deprecated: Use top level BreakRule instead. Rules to generate time breaks for a vehicle (e.g. lunch |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest |
The sequence of breaks (i.e. their number and order) that apply to each
vehicle must be known beforehand. The repeated BreakRequests define
that sequence, in the order in which they must occur. Their time windows |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule.BreakRequest.Builder |
The sequence of breaks (i.e. their number and order) that apply to each
vehicle must be known beforehand. The repeated BreakRequests define
that sequence, in the order in which they must occur. Their time windows |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule.Builder | Deprecated: Use top level BreakRule instead. Rules to generate time breaks for a vehicle (e.g. lunch |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint | One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that |
| com.google.cloud.optimization.v1.ShipmentModel.BreakRule.FrequencyConstraint.Builder | One may further constrain the frequency and duration of the breaks specified above, by enforcing a minimum break frequency, such as "There must be a break of at least 1 hour every 12 hours". Assuming that |
| com.google.cloud.optimization.v1.ShipmentModel.Builder | A shipment model contains a set of shipments which must be performed by a set of vehicles, while minimizing the overall cost, which is the sum of: |
| com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix | Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations. |
| com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix.Builder | Specifies a duration and distance matrix from visit and vehicle start locations to visit and vehicle end locations. |
| com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix.Row | Specifies a row of the duration and distance matrix. |
| com.google.cloud.optimization.v1.ShipmentModel.DurationDistanceMatrix.Row.Builder | Specifies a row of the duration and distance matrix. |
| com.google.cloud.optimization.v1.ShipmentModel.PrecedenceRule |
A precedence rule between two events (each event is the pickup or the
delivery of a shipment): the "second" event has to start at least
offset_duration after "first" has started. |
| com.google.cloud.optimization.v1.ShipmentModel.PrecedenceRule.Builder |
A precedence rule between two events (each event is the pickup or the
delivery of a shipment): the "second" event has to start at least
offset_duration after "first" has started. |
| com.google.cloud.optimization.v1.ShipmentRoute |
A vehicle's route can be decomposed, along the time axis, like this (we
assume there are n visits):
<code></td>
</tr>
<tr>
<td><a href="https://cloud.google.com/java/docs/reference/google-cloud-optimization/latest/com.google.cloud.optimization.v1.ShipmentRoute.Break">com.google.cloud.optimization.v1.ShipmentRoute.Break</a></td>
<td>
Data representing the execution of a break.
</td>
</tr>
<tr>
<td><a href="https://cloud.google.com/java/docs/reference/google-cloud-optimization/latest/com.google.cloud.optimization.v1.ShipmentRoute.Break.Builder">com.google.cloud.optimization.v1.ShipmentRoute.Break.Builder</a></td>
<td>
Data representing the execution of a break.
</td>
</tr>
<tr>
<td><a href="https://cloud.google.com/java/docs/reference/google-cloud-optimization/latest/com.google.cloud.optimization.v1.ShipmentRoute.Builder">com.google.cloud.optimization.v1.ShipmentRoute.Builder</a></td>
<td>
A vehicle's route can be decomposed, along the time axis, like this (we
assume there are n visits): |
| com.google.cloud.optimization.v1.ShipmentRoute.Delay | Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Time interval spent on the route resulting from a |
| com.google.cloud.optimization.v1.ShipmentRoute.Delay.Builder | Deprecated: Use ShipmentRoute.Transition.delay_duration instead. Time interval spent on the route resulting from a |
| com.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline | The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm |
| com.google.cloud.optimization.v1.ShipmentRoute.EncodedPolyline.Builder | The encoded representation of a polyline. More information on polyline encoding can be found here: https://developers.google.com/maps/documentation/utilities/polylinealgorithm |
| com.google.cloud.optimization.v1.ShipmentRoute.Transition | Transition between two events on the route. See the description of ShipmentRoute. |
| com.google.cloud.optimization.v1.ShipmentRoute.Transition.Builder | Transition between two events on the route. See the description of ShipmentRoute. |
| com.google.cloud.optimization.v1.ShipmentRoute.TravelStep | Deprecated: Use ShipmentRoute.Transition instead. Travel between each visit along the route: from the vehicle's |
| com.google.cloud.optimization.v1.ShipmentRoute.TravelStep.Builder | Deprecated: Use ShipmentRoute.Transition instead. Travel between each visit along the route: from the vehicle's |
| com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad | Reports the actual load of the vehicle at some point along the route, for a given type (see Transition.vehicle_loads). |
| com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad.Builder | Reports the actual load of the vehicle at some point along the route, for a given type (see Transition.vehicle_loads). |
| com.google.cloud.optimization.v1.ShipmentRoute.Visit |
A visit performed during a route. This visit corresponds to a pickup or a
delivery of a Shipment.
|
| com.google.cloud.optimization.v1.ShipmentRoute.Visit.Builder |
A visit performed during a route. This visit corresponds to a pickup or a
delivery of a Shipment.
|
| com.google.cloud.optimization.v1.ShipmentTypeIncompatibility | Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode. |
| com.google.cloud.optimization.v1.ShipmentTypeIncompatibility.Builder | Specifies incompatibilties between shipments depending on their shipment_type. The appearance of incompatible shipments on the same route is restricted based on the incompatibility mode. |
| com.google.cloud.optimization.v1.ShipmentTypeRequirement | Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode. |
| com.google.cloud.optimization.v1.ShipmentTypeRequirement.Builder | Specifies requirements between shipments based on their shipment_type. The specifics of the requirement are defined by the requirement mode. |
| com.google.cloud.optimization.v1.SkippedShipment | Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here. |
| com.google.cloud.optimization.v1.SkippedShipment.Builder | Specifies details of unperformed shipments in a solution. For trivial cases and/or if we are able to identify the cause for skipping, we report the reason here. |
| com.google.cloud.optimization.v1.SkippedShipment.Reason |
If we can explain why the shipment was skipped, reasons will be listed
here. If the reason is not the same for all vehicles, reason will have
more than 1 element. A skipped shipment cannot have duplicate reasons, |
| com.google.cloud.optimization.v1.SkippedShipment.Reason.Builder |
If we can explain why the shipment was skipped, reasons will be listed
here. If the reason is not the same for all vehicles, reason will have
more than 1 element. A skipped shipment cannot have duplicate reasons, |
| com.google.cloud.optimization.v1.TimeWindow | 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. |
| com.google.cloud.optimization.v1.TimeWindow.Builder | 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. |
| com.google.cloud.optimization.v1.TransitionAttributes |
Specifies attributes of transitions between two consecutive visits on a
route. Several TransitionAttributes may apply to the same transition: in
that case, all extra costs add up and the strictest constraint or limit |
| com.google.cloud.optimization.v1.TransitionAttributes.Builder |
Specifies attributes of transitions between two consecutive visits on a
route. Several TransitionAttributes may apply to the same transition: in
that case, all extra costs add up and the strictest constraint or limit |
| com.google.cloud.optimization.v1.Vehicle |
Models a vehicle in a shipment problem. Solving a shipment problem will
build a route starting from start_location and ending at end_location
for this vehicle. A route is a sequence of visits (see ShipmentRoute). |
| com.google.cloud.optimization.v1.Vehicle.Builder |
Models a vehicle in a shipment problem. Solving a shipment problem will
build a route starting from start_location and ending at end_location
for this vehicle. A route is a sequence of visits (see ShipmentRoute). |
| com.google.cloud.optimization.v1.Vehicle.DurationLimit | A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft. |
| com.google.cloud.optimization.v1.Vehicle.DurationLimit.Builder | A limit defining a maximum duration of the route of a vehicle. It can be either hard or soft. |
| com.google.cloud.optimization.v1.Vehicle.LoadLimit | Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See load_limits. |
| com.google.cloud.optimization.v1.Vehicle.LoadLimit.Builder | Defines a load limit applying to a vehicle, e.g. "this truck may only carry up to 3500 kg". See load_limits. |
| com.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval | Interval of acceptable load amounts. |
| com.google.cloud.optimization.v1.Vehicle.LoadLimit.Interval.Builder | Interval of acceptable load amounts. |
| com.google.cloud.optimization.v1.Waypoint | Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles. |
| com.google.cloud.optimization.v1.Waypoint.Builder | Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com.google.cloud.optimization.v1.AsyncModelMetadata.State | Possible states of the operation. |
| com.google.cloud.optimization.v1.DataFormat | Data formats for input and output files. |
| com.google.cloud.optimization.v1.InjectedSolutionConstraint.ConstraintRelaxation.Relaxation.Level | Expresses the different constraint relaxation levels, which are applied for a visit and those that follow when it satisfies the threshold conditions. |
| com.google.cloud.optimization.v1.InputConfig.SourceCase | |
| com.google.cloud.optimization.v1.OptimizeToursRequest.SearchMode | Mode defining the behavior of the search, trading off latency versus solution quality. In all modes, the global request deadline is enforced. |
| com.google.cloud.optimization.v1.OptimizeToursRequest.SolvingMode |
Defines how the solver should handle the request. In all modes but
VALIDATE_ONLY, if the request is invalid, you will receive an
INVALID_REQUEST error. See |
| com.google.cloud.optimization.v1.OptimizeToursValidationError.FieldReference.IndexOrKeyCase | |
| com.google.cloud.optimization.v1.OutputConfig.DestinationCase | |
| com.google.cloud.optimization.v1.ShipmentTypeIncompatibility.IncompatibilityMode | Modes defining how the appearance of incompatible shipments are restricted on the same route. |
| com.google.cloud.optimization.v1.ShipmentTypeRequirement.RequirementMode | Modes defining the appearance of dependent shipments on a route. |
| com.google.cloud.optimization.v1.SkippedShipment.Reason.Code | Code identifying the reason type. The order here is meaningless. In particular, it gives no indication of whether a given reason will appear before another in the solution, if both apply. |
| com.google.cloud.optimization.v1.Vehicle.TravelMode | Travel modes which can be used by vehicles. These should be a subset of the Google Maps Platform Routes Preferred API |
| com.google.cloud.optimization.v1.Vehicle.UnloadingPolicy | Policy on how a vehicle can be unloaded. Applies only to shipments having both a pickup and a delivery. |
| com.google.cloud.optimization.v1.Waypoint.LocationTypeCase |