Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [cloudoptimization] clarification for deprecated fields #9062

Merged
merged 2 commits into from
Feb 2, 2023
Merged

docs: [cloudoptimization] clarification for deprecated fields #9062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
338b387
docs: clarification for deprecated fields
gcf-owl-bot[bot] Feb 2, 2023
6fc8d38
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Feb 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions java-optimization/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-optimization</artifactId>
<version>1.6.0</version>
<version>1.7.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-optimization:1.6.0'
implementation 'com.google.cloud:google-cloud-optimization:1.7.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-optimization" % "1.6.0"
libraryDependencies += "com.google.cloud" % "google-cloud-optimization" % "1.7.0"
```

## Authentication
Expand Down
113 changes: 79 additions & 34 deletions ...oud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,8 +604,11 @@ public int getCostsCount() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -628,8 +631,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCosts() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -643,8 +649,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCostsMap() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -662,8 +671,11 @@ public double getCostsOrDefault(java.lang.String key, double defaultValue) {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -687,14 +699,17 @@ public double getCostsOrThrow(java.lang.String key) {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
* [OptimizeToursResponse.Metrics.total_cost][] instead.
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
* </pre>
*
* <code>double total_cost = 11 [deprecated = true];</code>
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @return The totalCost.
*/
@java.lang.Override
Expand Down Expand Up @@ -2897,8 +2912,11 @@ public int getCostsCount() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -2921,8 +2939,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCosts() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -2936,8 +2957,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCostsMap() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -2955,8 +2979,11 @@ public double getCostsOrDefault(java.lang.String key, double defaultValue) {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand Down Expand Up @@ -2984,8 +3011,11 @@ public Builder clearCosts() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -3008,8 +3038,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getMutableCosts() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -3028,8 +3061,11 @@ public Builder putCosts(java.lang.String key, double value) {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -3046,14 +3082,17 @@ public Builder putAllCosts(java.util.Map<java.lang.String, java.lang.Double> val
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
* [OptimizeToursResponse.Metrics.total_cost][] instead.
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
* </pre>
*
* <code>double total_cost = 11 [deprecated = true];</code>
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @return The totalCost.
*/
@java.lang.Override
Expand All @@ -3065,14 +3104,17 @@ public double getTotalCost() {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
* [OptimizeToursResponse.Metrics.total_cost][] instead.
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
* </pre>
*
* <code>double total_cost = 11 [deprecated = true];</code>
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @param value The totalCost to set.
* @return This builder for chaining.
*/
Expand All @@ -3088,14 +3130,17 @@ public Builder setTotalCost(double value) {
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
* [OptimizeToursResponse.Metrics.total_cost][] instead.
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
* </pre>
*
* <code>double total_cost = 11 [deprecated = true];</code>
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @return This builder for chaining.
*/
@java.lang.Deprecated
Expand Down
44 changes: 31 additions & 13 deletions ...ization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetricsOrBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,8 +367,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -379,8 +382,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -394,8 +400,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -406,8 +415,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -418,8 +430,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_costs][] and
* [OptimizeToursResponse.Metrics.costs][] instead.
* Deprecated: Use
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
* and
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
* instead.
* </pre>
*
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
Expand All @@ -431,14 +446,17 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
*
*
* <pre>
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
* [OptimizeToursResponse.Metrics.total_cost][] instead.
* Deprecated: Use
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
* and
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
* instead.
* </pre>
*
* <code>double total_cost = 11 [deprecated = true];</code>
*
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
* @return The totalCost.
*/
@java.lang.Deprecated
Expand Down
10 changes: 6 additions & 4 deletions ...loud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@
*
*
* <pre>
* Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and
* [ShipmentRoute.VehicleLoad][] instead.
* Deprecated: Use
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
* instead.
* </pre>
*
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantity}
Expand Down Expand Up @@ -292,8 +293,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and
* [ShipmentRoute.VehicleLoad][] instead.
* Deprecated: Use
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
* instead.
* </pre>
*
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantity}
Expand Down
8 changes: 6 additions & 2 deletions ...imization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantityInterval.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
*
*
* <pre>
* Deprecated: Use [Vehicle.LoadLimit.Interval][] instead.
* Deprecated: Use
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
* instead.
* </pre>
*
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantityInterval}
Expand Down Expand Up @@ -342,7 +344,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
*
*
* <pre>
* Deprecated: Use [Vehicle.LoadLimit.Interval][] instead.
* Deprecated: Use
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
* instead.
* </pre>
*
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantityInterval}
Expand Down
Loading