Skip to content

Commit 8816cde

Browse files
docs: [cloudoptimization] clarification for deprecated fields (#9062)
* docs: clarification for deprecated fields PiperOrigin-RevId: 506637342 Source-Link: googleapis/googleapis@9821393 Source-Link: https://github.com/googleapis/googleapis-gen/commit/d9d93e022548947045bef32a4245e3ba5c936808 Copy-Tag: eyJwIjoiamF2YS1vcHRpbWl6YXRpb24vLk93bEJvdC55YW1sIiwiaCI6ImQ5ZDkzZTAyMjU0ODk0NzA0NWJlZjMyYTQyNDVlM2JhNWM5MzY4MDgifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent dd109d8 commit 8816cde

22 files changed

+1452
-744
lines changed

java-optimization/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
1919
<dependency>
2020
<groupId>com.google.cloud</groupId>
2121
<artifactId>google-cloud-optimization</artifactId>
22-
<version>1.6.0</version>
22+
<version>1.7.0</version>
2323
</dependency>
2424
```
2525

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

2828
```Groovy
29-
implementation 'com.google.cloud:google-cloud-optimization:1.6.0'
29+
implementation 'com.google.cloud:google-cloud-optimization:1.7.0'
3030
```
3131

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

3434
```Scala
35-
libraryDependencies += "com.google.cloud" % "google-cloud-optimization" % "1.6.0"
35+
libraryDependencies += "com.google.cloud" % "google-cloud-optimization" % "1.7.0"
3636
```
3737

3838
## Authentication

java-optimization/proto-google-cloud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetrics.java

Lines changed: 79 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -604,8 +604,11 @@ public int getCostsCount() {
604604
*
605605
*
606606
* <pre>
607-
* Deprecated: Use [ShipmentRoute.route_costs][] and
608-
* [OptimizeToursResponse.Metrics.costs][] instead.
607+
* Deprecated: Use
608+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
609+
* and
610+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
611+
* instead.
609612
* </pre>
610613
*
611614
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -628,8 +631,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCosts() {
628631
*
629632
*
630633
* <pre>
631-
* Deprecated: Use [ShipmentRoute.route_costs][] and
632-
* [OptimizeToursResponse.Metrics.costs][] instead.
634+
* Deprecated: Use
635+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
636+
* and
637+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
638+
* instead.
633639
* </pre>
634640
*
635641
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -643,8 +649,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCostsMap() {
643649
*
644650
*
645651
* <pre>
646-
* Deprecated: Use [ShipmentRoute.route_costs][] and
647-
* [OptimizeToursResponse.Metrics.costs][] instead.
652+
* Deprecated: Use
653+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
654+
* and
655+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
656+
* instead.
648657
* </pre>
649658
*
650659
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -662,8 +671,11 @@ public double getCostsOrDefault(java.lang.String key, double defaultValue) {
662671
*
663672
*
664673
* <pre>
665-
* Deprecated: Use [ShipmentRoute.route_costs][] and
666-
* [OptimizeToursResponse.Metrics.costs][] instead.
674+
* Deprecated: Use
675+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
676+
* and
677+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
678+
* instead.
667679
* </pre>
668680
*
669681
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -687,14 +699,17 @@ public double getCostsOrThrow(java.lang.String key) {
687699
*
688700
*
689701
* <pre>
690-
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
691-
* [OptimizeToursResponse.Metrics.total_cost][] instead.
702+
* Deprecated: Use
703+
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
704+
* and
705+
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
706+
* instead.
692707
* </pre>
693708
*
694709
* <code>double total_cost = 11 [deprecated = true];</code>
695710
*
696711
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
697-
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
712+
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
698713
* @return The totalCost.
699714
*/
700715
@java.lang.Override
@@ -2897,8 +2912,11 @@ public int getCostsCount() {
28972912
*
28982913
*
28992914
* <pre>
2900-
* Deprecated: Use [ShipmentRoute.route_costs][] and
2901-
* [OptimizeToursResponse.Metrics.costs][] instead.
2915+
* Deprecated: Use
2916+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
2917+
* and
2918+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
2919+
* instead.
29022920
* </pre>
29032921
*
29042922
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -2921,8 +2939,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCosts() {
29212939
*
29222940
*
29232941
* <pre>
2924-
* Deprecated: Use [ShipmentRoute.route_costs][] and
2925-
* [OptimizeToursResponse.Metrics.costs][] instead.
2942+
* Deprecated: Use
2943+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
2944+
* and
2945+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
2946+
* instead.
29262947
* </pre>
29272948
*
29282949
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -2936,8 +2957,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getCostsMap() {
29362957
*
29372958
*
29382959
* <pre>
2939-
* Deprecated: Use [ShipmentRoute.route_costs][] and
2940-
* [OptimizeToursResponse.Metrics.costs][] instead.
2960+
* Deprecated: Use
2961+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
2962+
* and
2963+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
2964+
* instead.
29412965
* </pre>
29422966
*
29432967
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -2955,8 +2979,11 @@ public double getCostsOrDefault(java.lang.String key, double defaultValue) {
29552979
*
29562980
*
29572981
* <pre>
2958-
* Deprecated: Use [ShipmentRoute.route_costs][] and
2959-
* [OptimizeToursResponse.Metrics.costs][] instead.
2982+
* Deprecated: Use
2983+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
2984+
* and
2985+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
2986+
* instead.
29602987
* </pre>
29612988
*
29622989
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -2984,8 +3011,11 @@ public Builder clearCosts() {
29843011
*
29853012
*
29863013
* <pre>
2987-
* Deprecated: Use [ShipmentRoute.route_costs][] and
2988-
* [OptimizeToursResponse.Metrics.costs][] instead.
3014+
* Deprecated: Use
3015+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
3016+
* and
3017+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
3018+
* instead.
29893019
* </pre>
29903020
*
29913021
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -3008,8 +3038,11 @@ public java.util.Map<java.lang.String, java.lang.Double> getMutableCosts() {
30083038
*
30093039
*
30103040
* <pre>
3011-
* Deprecated: Use [ShipmentRoute.route_costs][] and
3012-
* [OptimizeToursResponse.Metrics.costs][] instead.
3041+
* Deprecated: Use
3042+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
3043+
* and
3044+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
3045+
* instead.
30133046
* </pre>
30143047
*
30153048
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -3028,8 +3061,11 @@ public Builder putCosts(java.lang.String key, double value) {
30283061
*
30293062
*
30303063
* <pre>
3031-
* Deprecated: Use [ShipmentRoute.route_costs][] and
3032-
* [OptimizeToursResponse.Metrics.costs][] instead.
3064+
* Deprecated: Use
3065+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
3066+
* and
3067+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
3068+
* instead.
30333069
* </pre>
30343070
*
30353071
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -3046,14 +3082,17 @@ public Builder putAllCosts(java.util.Map<java.lang.String, java.lang.Double> val
30463082
*
30473083
*
30483084
* <pre>
3049-
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
3050-
* [OptimizeToursResponse.Metrics.total_cost][] instead.
3085+
* Deprecated: Use
3086+
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
3087+
* and
3088+
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
3089+
* instead.
30513090
* </pre>
30523091
*
30533092
* <code>double total_cost = 11 [deprecated = true];</code>
30543093
*
30553094
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
3056-
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
3095+
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
30573096
* @return The totalCost.
30583097
*/
30593098
@java.lang.Override
@@ -3065,14 +3104,17 @@ public double getTotalCost() {
30653104
*
30663105
*
30673106
* <pre>
3068-
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
3069-
* [OptimizeToursResponse.Metrics.total_cost][] instead.
3107+
* Deprecated: Use
3108+
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
3109+
* and
3110+
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
3111+
* instead.
30703112
* </pre>
30713113
*
30723114
* <code>double total_cost = 11 [deprecated = true];</code>
30733115
*
30743116
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
3075-
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
3117+
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
30763118
* @param value The totalCost to set.
30773119
* @return This builder for chaining.
30783120
*/
@@ -3088,14 +3130,17 @@ public Builder setTotalCost(double value) {
30883130
*
30893131
*
30903132
* <pre>
3091-
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
3092-
* [OptimizeToursResponse.Metrics.total_cost][] instead.
3133+
* Deprecated: Use
3134+
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
3135+
* and
3136+
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
3137+
* instead.
30933138
* </pre>
30943139
*
30953140
* <code>double total_cost = 11 [deprecated = true];</code>
30963141
*
30973142
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
3098-
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
3143+
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
30993144
* @return This builder for chaining.
31003145
*/
31013146
@java.lang.Deprecated

java-optimization/proto-google-cloud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetricsOrBuilder.java

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -367,8 +367,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
367367
*
368368
*
369369
* <pre>
370-
* Deprecated: Use [ShipmentRoute.route_costs][] and
371-
* [OptimizeToursResponse.Metrics.costs][] instead.
370+
* Deprecated: Use
371+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
372+
* and
373+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
374+
* instead.
372375
* </pre>
373376
*
374377
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -379,8 +382,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
379382
*
380383
*
381384
* <pre>
382-
* Deprecated: Use [ShipmentRoute.route_costs][] and
383-
* [OptimizeToursResponse.Metrics.costs][] instead.
385+
* Deprecated: Use
386+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
387+
* and
388+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
389+
* instead.
384390
* </pre>
385391
*
386392
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -394,8 +400,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
394400
*
395401
*
396402
* <pre>
397-
* Deprecated: Use [ShipmentRoute.route_costs][] and
398-
* [OptimizeToursResponse.Metrics.costs][] instead.
403+
* Deprecated: Use
404+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
405+
* and
406+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
407+
* instead.
399408
* </pre>
400409
*
401410
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -406,8 +415,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
406415
*
407416
*
408417
* <pre>
409-
* Deprecated: Use [ShipmentRoute.route_costs][] and
410-
* [OptimizeToursResponse.Metrics.costs][] instead.
418+
* Deprecated: Use
419+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
420+
* and
421+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
422+
* instead.
411423
* </pre>
412424
*
413425
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -418,8 +430,11 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
418430
*
419431
*
420432
* <pre>
421-
* Deprecated: Use [ShipmentRoute.route_costs][] and
422-
* [OptimizeToursResponse.Metrics.costs][] instead.
433+
* Deprecated: Use
434+
* [ShipmentRoute.route_costs][google.cloud.optimization.v1.ShipmentRoute.route_costs]
435+
* and
436+
* [OptimizeToursResponse.Metrics.costs][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.costs]
437+
* instead.
423438
* </pre>
424439
*
425440
* <code>map&lt;string, double&gt; costs = 10 [deprecated = true];</code>
@@ -431,14 +446,17 @@ com.google.cloud.optimization.v1.ShipmentRoute.VehicleLoad getMaxLoadsOrThrow(
431446
*
432447
*
433448
* <pre>
434-
* Deprecated: Use [ShipmentRoute.route_total_cost][] and
435-
* [OptimizeToursResponse.Metrics.total_cost][] instead.
449+
* Deprecated: Use
450+
* [ShipmentRoute.route_total_cost][google.cloud.optimization.v1.ShipmentRoute.route_total_cost]
451+
* and
452+
* [OptimizeToursResponse.Metrics.total_cost][google.cloud.optimization.v1.OptimizeToursResponse.Metrics.total_cost]
453+
* instead.
436454
* </pre>
437455
*
438456
* <code>double total_cost = 11 [deprecated = true];</code>
439457
*
440458
* @deprecated google.cloud.optimization.v1.AggregatedMetrics.total_cost is deprecated. See
441-
* google/cloud/optimization/v1/fleet_routing.proto;l=2296
459+
* google/cloud/optimization/v1/fleet_routing.proto;l=2331
442460
* @return The totalCost.
443461
*/
444462
@java.lang.Deprecated

java-optimization/proto-google-cloud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantity.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,9 @@
2222
*
2323
*
2424
* <pre>
25-
* Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and
26-
* [ShipmentRoute.VehicleLoad][] instead.
25+
* Deprecated: Use
26+
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
27+
* instead.
2728
* </pre>
2829
*
2930
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantity}
@@ -292,8 +293,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
292293
*
293294
*
294295
* <pre>
295-
* Deprecated: Use [Shipment.Load][], [Vehicle.LoadLimit][] and
296-
* [ShipmentRoute.VehicleLoad][] instead.
296+
* Deprecated: Use
297+
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
298+
* instead.
297299
* </pre>
298300
*
299301
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantity}

java-optimization/proto-google-cloud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantityInterval.java

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@
2222
*
2323
*
2424
* <pre>
25-
* Deprecated: Use [Vehicle.LoadLimit.Interval][] instead.
25+
* Deprecated: Use
26+
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
27+
* instead.
2628
* </pre>
2729
*
2830
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantityInterval}
@@ -342,7 +344,9 @@ protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.Build
342344
*
343345
*
344346
* <pre>
345-
* Deprecated: Use [Vehicle.LoadLimit.Interval][] instead.
347+
* Deprecated: Use
348+
* [Vehicle.LoadLimit.Interval][google.cloud.optimization.v1.Vehicle.LoadLimit.Interval]
349+
* instead.
346350
* </pre>
347351
*
348352
* Protobuf type {@code google.cloud.optimization.v1.CapacityQuantityInterval}

0 commit comments

Comments
 (0)