chore: deprecate legacy fields related to load balancing

docs: update comments for fields related to load balancing PiperOrigin-RevId: 618165773
googleapis · Mar 22, 2024 · 2bc2029 · 2bc2029
1 parent 5ce591f
commit 2bc2029
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/google/cloud/networkmanagement/v1/connectivity_test.proto b/google/cloud/networkmanagement/v1/connectivity_test.proto
@@ -186,9 +186,6 @@ message Endpoint {
   }
 
   // The IP address of the endpoint, which can be an external or internal IP.
-  // An IPv6 address is only allowed when the test's destination is a
-  // [global load balancer
-  // VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
   string ip_address = 1;
 
   // The IP protocol port of the endpoint.

diff --git a/google/cloud/networkmanagement/v1/trace.proto b/google/cloud/networkmanagement/v1/trace.proto
@@ -124,10 +124,10 @@ message Step {
     ARRIVE_AT_INSTANCE = 9;
 
     // Forwarding state: arriving at a Compute Engine internal load balancer.
-    ARRIVE_AT_INTERNAL_LOAD_BALANCER = 10;
+    ARRIVE_AT_INTERNAL_LOAD_BALANCER = 10 [deprecated = true];
 
     // Forwarding state: arriving at a Compute Engine external load balancer.
-    ARRIVE_AT_EXTERNAL_LOAD_BALANCER = 11;
+    ARRIVE_AT_EXTERNAL_LOAD_BALANCER = 11 [deprecated = true];
 
     // Forwarding state: arriving at a Cloud VPN gateway.
     ARRIVE_AT_VPN_GATEWAY = 12;
@@ -223,8 +223,9 @@ message Step {
     // Display information of the final state "drop" and reason.
     DropInfo drop = 15;
 
-    // Display information of the load balancers.
-    LoadBalancerInfo load_balancer = 16;
+    // Display information of the load balancers. Deprecated in favor of the
+    // `load_balancer_backend_info` field, not used in new tests.
+    LoadBalancerInfo load_balancer = 16 [deprecated = true];
 
     // Display information of a Google Cloud network.
     NetworkInfo network = 17;
@@ -626,8 +627,10 @@ message LoadBalancerInfo {
   // Type of the load balancer.
   LoadBalancerType load_balancer_type = 1;
 
-  // URI of the health check for the load balancer.
-  string health_check_uri = 2;
+  // URI of the health check for the load balancer. Deprecated and no longer
+  // populated as different load balancer backends might have different health
+  // checks.
+  string health_check_uri = 2 [deprecated = true];
 
   // Information for the loadbalancer backends.
   repeated LoadBalancerBackend backends = 3;

diff --git a/google/cloud/networkmanagement/v1beta1/connectivity_test.proto b/google/cloud/networkmanagement/v1beta1/connectivity_test.proto
@@ -186,9 +186,6 @@ message Endpoint {
   }
 
   // The IP address of the endpoint, which can be an external or internal IP.
-  // An IPv6 address is only allowed when the test's destination is a
-  // [global load balancer
-  // VIP](https://cloud.google.com/load-balancing/docs/load-balancing-overview).
   string ip_address = 1;
 
   // The IP protocol port of the endpoint.

diff --git a/google/cloud/networkmanagement/v1beta1/trace.proto b/google/cloud/networkmanagement/v1beta1/trace.proto
@@ -124,10 +124,10 @@ message Step {
     ARRIVE_AT_INSTANCE = 9;
 
     // Forwarding state: arriving at a Compute Engine internal load balancer.
-    ARRIVE_AT_INTERNAL_LOAD_BALANCER = 10;
+    ARRIVE_AT_INTERNAL_LOAD_BALANCER = 10 [deprecated = true];
 
     // Forwarding state: arriving at a Compute Engine external load balancer.
-    ARRIVE_AT_EXTERNAL_LOAD_BALANCER = 11;
+    ARRIVE_AT_EXTERNAL_LOAD_BALANCER = 11 [deprecated = true];
 
     // Forwarding state: arriving at a Cloud VPN gateway.
     ARRIVE_AT_VPN_GATEWAY = 12;
@@ -223,8 +223,9 @@ message Step {
     // Display information of the final state "drop" and reason.
     DropInfo drop = 15;
 
-    // Display information of the load balancers.
-    LoadBalancerInfo load_balancer = 16;
+    // Display information of the load balancers. Deprecated in favor of the
+    // `load_balancer_backend_info` field, not used in new tests.
+    LoadBalancerInfo load_balancer = 16 [deprecated = true];
 
     // Display information of a Google Cloud network.
     NetworkInfo network = 17;
@@ -626,8 +627,10 @@ message LoadBalancerInfo {
   // Type of the load balancer.
   LoadBalancerType load_balancer_type = 1;
 
-  // URI of the health check for the load balancer.
-  string health_check_uri = 2;
+  // URI of the health check for the load balancer. Deprecated and no longer
+  // populated as different load balancer backends might have different health
+  // checks.
+  string health_check_uri = 2 [deprecated = true];
 
   // Information for the loadbalancer backends.
   repeated LoadBalancerBackend backends = 3;