docs: [cloudoptimization] clarification for deprecated fields (#9062)

* docs: clarification for deprecated fields PiperOrigin-RevId: 506637342 Source-Link: googleapis/googleapis@9821393 Source-Link: googleapis/googleapis-gen@d9d93e0 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>
googleapis · Feb 2, 2023 · 8816cde · 8816cde
1 parent dd109d8
commit 8816cde
Show file tree

Hide file tree

Showing 22 changed files with 1,452 additions and 744 deletions.
diff --git a/java-optimization/README.md b/java-optimization/README.md
@@ -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

diff --git a/...oud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetrics.java b/...oud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetrics.java
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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
@@ -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.
      */
@@ -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

diff --git a/...ization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetricsOrBuilder.java b/...ization-v1/src/main/java/com/google/cloud/optimization/v1/AggregatedMetricsOrBuilder.java
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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

diff --git a/...loud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantity.java b/...loud-optimization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantity.java
@@ -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}
@@ -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}

diff --git a/...imization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantityInterval.java b/...imization-v1/src/main/java/com/google/cloud/optimization/v1/CapacityQuantityInterval.java
@@ -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}
@@ -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}